The deoxybyte-gzip Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The deoxybyte-gzip Reference Manual

This is the deoxybyte-gzip Reference Manual, version 0.6.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:36:59 2022 GMT+0.

Table of Contents


1 Introduction

Introduction

This system provides gzip and gunzip functions and a Gray-streams
implementation, both built on a set of lower-level zlib functions.

Functions are provided for inflating and deflating to and from Lisp
octet vectors and Lisp octet streams, which may be tuned using the
Zlib tuning parameters described in the Zlib C function deflateInit2.

In addition, a basic implementation of the data structure described in
RFC1952 is included, allowing a hybrid approach to reading gzip data,
using native Lisp streams and Zlib inflate/deflate.

Measuring execution times of the gz:gzip and gz:gunzip functions shows
deoxybyte-gzip to be fractionally slower than gzip, but over 3x slower
than gunzip.

Relative execution time (SBCL 1.0.40 X86-64):

                  gzip   deoxybyte-gzip     gzip-stream
  Compression      1.0             1.1             1.1
Decompression      1.0             3.1             3.5

Timings were taken compressing and decompressing a 1.8 Gb text file
using gzip/gunzip command line programs, the gz:gzip/gz:gunzip
functions (which use an internal buffer of length 2^16 -1) and the
Gray streams classes using
gz:stream-read-sequence/gz:stream-write-sequence methods. A zlib
compression level of 6 was used.

This system is named with a deoxybyte- prefix because there are
several existing Common Lisp packages using the gzip name and I don't
want to clash with them.


Installation

deoxybyte-gzip uses ASDF for system definition. Copy or symlink
deoxybyte-gzip.asd (and optionally deoxybyte-gzip-test.asd) to your
asdf:*central-registry* and load deoxybyte-io with the asdf:operate
function:

 (asdf:operate 'asdf:load-op :deoxybyte-gzip)

or with the equivalent deoxybyte-systems:load-system function:

 (dxs:load-system :deoxybyte-gzip)


Tests

To run the unit and regression tests you need to have LIFT
installed. Run the tests with the asdf:operate function:

 (asdf:operate 'asdf:test-op :deoxybyte-gzip)

or with the equivalent deoxybyte-systems:test-system function:

 (dxs:test-system :deoxybyte-gzip)


Documentation

See the Lisp docstrings, particularly the package docstrings for an
overview. HTML documentation may be generated with the command:

 (dxs:document-system :deoxybyte-gzip)

at the REPL, provided that CLDOC is installed.


Dependencies

deoxybyte-systems       git://github.com/keithj/deoxybyte-systems.git
deoxybyte-io            git://github.com/keithj/deoxybyte-io.git


Optional dependencies

LIFT                    http://common-lisp.net/project/lift/
CLDOC                   http://common-lisp.net/project/cldoc/


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 deoxybyte-gzip

Author

Keith James

License

GPL v3

Version

0.6.0

Dependencies
  • deoxybyte-systems (system)., at least version "1.0.0"
  • deoxybyte-io (system)., at least version "0.15.0"
  • deoxybyte-unix (system)., at least version "0.8.0"
Source

deoxybyte-gzip.asd.

Child Component

deoxybyte-gzip (module).


3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 deoxybyte-gzip/deoxybyte-gzip

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


4.1.1 deoxybyte-gzip/deoxybyte-gzip.asd

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (system).

ASDF Systems

deoxybyte-gzip.


4.1.2 deoxybyte-gzip/deoxybyte-gzip/package.lisp

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (module).

Packages

4.1.3 deoxybyte-gzip/deoxybyte-gzip/zlib-ffi.lisp

Dependency

package.lisp (file).

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (module).

Public Interface
Internals

4.1.4 deoxybyte-gzip/deoxybyte-gzip/rfc1952.lisp

Dependency

zlib-ffi.lisp (file).

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (module).

Public Interface
Internals

4.1.5 deoxybyte-gzip/deoxybyte-gzip/conditions.lisp

Dependency

rfc1952.lisp (file).

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (module).

Public Interface
Internals

errno-of (reader method).


4.1.6 deoxybyte-gzip/deoxybyte-gzip/deoxybyte-gzip.lisp

Dependency

conditions.lisp (file).

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (module).

Public Interface
Internals

4.1.7 deoxybyte-gzip/deoxybyte-gzip/gzip-stream.lisp

Dependency

deoxybyte-gzip.lisp (file).

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (module).

Public Interface
Internals

4.1.8 deoxybyte-gzip/deoxybyte-gzip/line-stream.lisp

Dependency

gzip-stream.lisp (file).

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (module).

Public Interface
Internals

4.1.9 deoxybyte-gzip/deoxybyte-gzip/sbcl.lisp

Dependency

line-stream.lisp (file).

Source

deoxybyte-gzip.asd.

Parent Component

deoxybyte-gzip (module).

Public Interface

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 zlib-ffi

The zlib-ffi package provides a FFI for most of
Zlib. It may be used directly, but is intended for use via the uk.co.deoxybyte-gzip package which wraps Zlib in a Lisp-style interface.

Source

package.lisp.

Use List
  • cffi.
  • common-lisp.
Used By List

uk.co.deoxybyte-gzip.

Public Interface
Internals

Previous: , Up: Packages   [Contents][Index]

5.2 uk.co.deoxybyte-gzip

The deoxybyte-gzip system provides a Lisp interface
to Zlib including a regular function interface to gzipped files, a Gray-streams interface to gzipped files and utility gzip/gunzip functions built on the former.

Functions are provided for inflating and deflating to and from Lisp octet vectors and Lisp octet streams, which may be tuned using the Zlib tuning parameters described in the Zlib C function deflateInit2.

In addition, a basic implementation of the data structure described in RFC1952 is included, allowing a hybrid approach to reading gzip data, using native Lisp streams and Zlib inflate/deflate.

Source

package.lisp.

Nicknames
  • gz
  • deoxybyte-gzip
Use List
  • cffi.
  • common-lisp.
  • uk.co.deoxybyte-io.
  • uk.co.deoxybyte-utilities.
  • zlib-ffi.
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Public Interface


6.1.1 Constants

Constant: +cm-deflate+

CM (Compression Method)

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +flag-comment+

FLG (FLaGs) FCOMMENT

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +flag-extra+

FLG (FLaGs) FEXTRA

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +flag-fhcrc+

FLG (FLaGs) FHCRC

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +flag-name+

FLG (FLaGs) FNAME

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +flag-text+

FLG (FLaGs) FTEXT

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +id1+

ID1 (IDentification 1)

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +id2+

ID2 (IDentification 2)

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-acorn-riscos+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-amiga+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-atari-tos+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-cp/m+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-fat-filesystem+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-hpfs-filesystem+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-macintosh+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-ntfs-filesystem+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-qdos+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-tops-20+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-unix+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-unknown+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-vm/cms+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-vms+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +os-z-system+
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +xfl-fastest+

XFL (eXtra FLags) compressor used fastest algorithm

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +xfl-slowest+

XFL (eXtra FLags) compressor used maximum compression, slowest algorithm

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Constant: +z-buf-error+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-data-error+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-default-compression+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-default-strategy+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-deflated+

Compression method

Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-errno+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-filtered+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-finish+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-full-flush+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-huffman-only+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-mem-error+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-need-dict+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-no-flush+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-null+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-ok+

No error.

Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-stream-end+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-stream-error+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-version-error+
Package

zlib-ffi.

Source

zlib-ffi.lisp.


Next: , Previous: , Up: Public Interface   [Contents][Index]

6.1.2 Symbol macros

Symbol Macro: *c-error-number*
Package

zlib-ffi.

Source

zlib-ffi.lisp.


6.1.3 Macros

Macro: deflate-init (strm level)

Macro that emulates Zlib’s deflateInit.

Package

zlib-ffi.

Source

zlib-ffi.lisp.

Macro: deflate-init2 (strm level method window-bits mem-level strategy)

Macro that emulates Zlib’s deflateInit2.

Package

zlib-ffi.

Source

zlib-ffi.lisp.

Macro: inflate-init (strm)

Macro that emulates Zlib’s inflateInit.

Package

zlib-ffi.

Source

zlib-ffi.lisp.

Macro: inflate-init2 (strm window-bits)

Macro that emulates Zlib’s inflateInit2.

Package

zlib-ffi.

Source

zlib-ffi.lisp.

Macro: with-gz-file ((var filespec &key direction compression) &body body)

Executes BODY with VAR bound to a GZ handle structure created by opening the file denoted by FILESPEC.

Arguments:

- var (symbol): The symbol to be bound.
- filespec (pathname designator): The file to open.

Key:

- direction (keyword): The direction, one of either :input or :output , defaulting to :input .
- compression (integer): The zlib compression level, if compressing. An integer between 0 and 9, inclusive.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Macro: with-open-gzip ((var filespec &rest args) &body body)
Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.


6.1.4 Ordinary functions

Function: %adler32 (adler bytes len)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %compress (dest destlen source sourcelen)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %compress2 (dest destlen source sourcelen level)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %crc32 (crc bytes len)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %deflate (strm flush)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %deflate-init (strm level version strm-size)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %deflate-init2 (strm level method window-bits mem-level strategy version strm-size)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %inflate (strm flush)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %inflate-init (strm version strm-size)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %inflate-init2 (strm window-bits version strm-size)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: %uncompress (dest destlen source sourcelen)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: adler32 (buffer &key start end adler32)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: compress (source dest &key source-start source-end dest-start compression)

Compresses bytes in array SOURCE to array DEST, returning DEST and the compressed size in bytes.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: crc32 (buffer &key start end crc32)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: deflate-end (strm)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: deflate-reset (strm)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: deflate-stream (source dest &key buffer-size compression suppress-header gzip-format window-bits mem-level strategy)

Deflates stream SOURCE to stream DEST.

Arguments:

- source (stream): A binary input stream.
- dest (stream): A binary output stream.

Key:

- buffer-size (fixnum): The size of the internal buffer used by Zlib. - compression (fixnum): The Zlib compression factor (0-9, inclusive). - suppress-header (boolean): Exposes a feature of Zlib whereby the compressed data may be produced without a Zlib header, trailer or checksum.
- gzip-format (boolean): write the gzip format instead of the Zlib format. - window-bits (fixnum): The Zlib window-bits argument (9-15, inclusive). - mem-level (fixnum): The Zlib mem-level argument (1-9, inclusive).
- strategy (fixnum): The Zlib strategy argument (one
of :default-strategy , :filtered or :huffman-only ).

Returns:
- Number of bytes read.
- Number of bytes written.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: deflate-vector (source dest &key compression suppress-header gzip-format window-bits mem-level strategy backoff)

Deflates vector SOURCE to vector DEST.

Arguments:

- source (vector): An octet vector.
- dest (vector): An octet vector.

Key:

- compression (fixnum): The Zlib compression factor (0-9, inclusive). - suppress-header (boolean): Exposes an undocumented feature of Zlib whereby the compressed data may be produced without a Zlib header or checksum.
- gzip-format (boolean): write the gzip format instead of the Zlib format. - window-bits (fixnum): The Zlib window-bits argument (9-15, inclusive). - mem-level (fixnum): The Zlib mem-level argument (1-9, inclusive).
- strategy (fixnum): The Zlib strategy argument (one
of :default-strategy , :filtered or :huffman-only ).

Returns:
- The DEST vector, containing compressed data.
- Number of bytes read.
- Number of bytes written (consequently the end position of the compressed data in DEST).

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gunzip (in-filespec &optional out-filespec)

Decompresses IN-FILESPEC to OUT-FILESPEC using the default compression level. Returns two values, OUT-FILESPEC and the number of bytes decompressed.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gunzip-pathname (pathname)

Returns a copy of PATHNAME. Any GZ type component is removed and the name component parsed to supply the new type, if possible.

For example:

foo.tar -> foo.tar
foo.tar.gz -> foo.tar

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-close (gz)

Closes GZ, if open.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-eof-p (gz)

Returns T if GZ has reached EOF, or NIL otherwise.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Reader: gz-member-cdata (instance)
Writer: (setf gz-member-cdata) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

cdata.

Reader: gz-member-cend (instance)
Writer: (setf gz-member-cend) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

cend.

Reader: gz-member-cm (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

cm.

Reader: gz-member-crc32 (instance)
Writer: (setf gz-member-crc32) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

crc32.

Reader: gz-member-flg (instance)
Writer: (setf gz-member-flg) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

flg.

Reader: gz-member-id1 (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

id1.

Reader: gz-member-id2 (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

id2.

Reader: gz-member-isize (instance)
Writer: (setf gz-member-isize) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

isize.

Reader: gz-member-mtime (instance)
Writer: (setf gz-member-mtime) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

mtime.

Reader: gz-member-os (instance)
Writer: (setf gz-member-os) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

os.

Reader: gz-member-xfl (instance)
Writer: (setf gz-member-xfl) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

xfl.

Reader: gz-member-xlen (instance)
Writer: (setf gz-member-xlen) (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Target Slot

xlen.

Function: gz-open (filespec &key direction compression)

Opens FILESPEC for compression or decompression.

Arguments:

- filespec (pathname designator): The file to open.

Key:

- direction (keyword): The direction, one of either :input or :output , defaulting to :input .
- compression (integer): The zlib compression level, if compressing. An integer between 0 and 9, inclusive.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-read (gz buffer n)

Reads up to N bytes from GZ into octet vector BUFFER. Returns the number of bytes read, which may be 0.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-read-byte (gz)

Returns a byte read from GZ, or :eof .

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-read-string (gz str n)

Reads up to N characters from GZ into string STR. Returns a string or :eof . Relies on the CFFI conversion terminating the returned string, so the result may be shorter than the STR argument.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-write (gz buffer n)

Writes up to N bytes in octet vector BUFFER to GZ. Returns the number of bytes written. BUFFER must be a simple-array of unsigned-byte 8.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-write-byte (gz byte)

Writes BYTE to GZ and returns BYTE.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-write-string (gz buffer)

Writes up to N characters in octet vector BUFFER to GZ. Returns the number of characters written.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gzclose (gz)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzdopen (fd mode)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzeof (gz)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzerror (gz errnum)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzflush (gz flush)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzgetc (gz)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzgets (gz buf len)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzip (in-filespec &optional out-filespec)

Compresses IN-FILESPEC to OUT-FILESPEC using the default compression level. Returns two values, OUT-FILESPEC and the number of bytes compressed.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gzip-open (filespec &key direction element-type compression)

Opens a gzip stream for FILESPEC.

Key:

- direction (symbol): One of :input (the default) or :output
- element-type (symbol): One of ’octet (the default) or ’string for input, or ’octet only for output.
- compression (integer): The zlib compression level, if compressing. An integer between 0 and 9, inclusive.

Returns:

- A {defclass gzip-stream}

Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.

Function: gzip-pathname (pathname)

Returns a copy of PATHNAME. A GZ type component is added, unless already present. Any existing type component becomes part of the name component.

For example:

foo.gz -> foo.gz
foo.tar -> foo.tar.gz

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gzopen (path mode)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzputc (gz char)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzputs (gz str)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzread (gz buf len)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzseek (gz offset whence)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gztell (gz)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: gzwrite (gz buf len)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: inflate-end (strm)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: inflate-reset (strm)
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: inflate-stream (source dest &key buffer-size suppress-header gzip-format window-bits)

Inflates stream SOURCE to stream DEST.

Arguments:

- source (stream): A binary input stream.
- dest (stream): A binary output stream.

Key:

- buffer-size (fixnum): The size of the internal buffer used by Zlib. - suppress-header (boolean): Exposes a feature of Zlib whereby the compressed data may be produced without a Zlib header, trailer or checksum. This must be set T if the data were compressed with the header suppressed.
- gzip-format (boolean): read the gzip format instead of the Zlib format. - window-bits (fixnum): The Zlib window-bits argument (9-15, inclusive).

Returns:
- Number of bytes read.
- Number of bytes written.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: inflate-vector (source dest &key suppress-header gzip-format window-bits backoff)

Inflates vector SOURCE to vector DEST.

Arguments:

- source (vector): An octet vector.
- dest (vector): An octet vector.

Key:

- compression (fixnum): The Zlib compression factor (0-9, inclusive). - suppress-header (boolean): Exposes an undocumented feature of Zlib whereby the compressed data may be produced without a Zlib header or checksum. This must be set T if the data were compressed with the header suppressed.
- gzip-format (boolean): read the gzip format instead of the Zlib format. - window-bits (fixnum): The Zlib window-bits argument (9-15, inclusive).

Returns:
- The DEST vector, containing decompressed data.
- Number of bytes read.
- Number of bytes written (consequently the end position of the decompressed data in DEST).

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: make-gz-member (&key id1 id2 cm flg mtime xfl os xlen isize crc32 cdata cend)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Function: uncompress (source dest &key source-start source-end dest-start)

Uncompresses bytes in array SOURCE to array DEST, returning DEST and the compressed size in bytes.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: zlib-version ()
Package

zlib-ffi.

Source

zlib-ffi.lisp.


6.1.5 Standalone methods

Method: more-lines-p ((stream gzip-line-input-stream))
Package

uk.co.deoxybyte-io.

Source

line-stream.lisp.

Method: open-stream-p ((stream gzip-stream))
Source

gzip-stream.lisp.

Method: stream-clear-input ((stream gzip-line-input-stream))
Package

sb-gray.

Source

line-stream.lisp.

Method: stream-clear-input ((stream gzip-input-stream))
Package

sb-gray.

Source

gzip-stream.lisp.

Method: stream-clear-output ((stream gzip-output-stream))
Package

sb-gray.

Source

gzip-stream.lisp.

Method: stream-close ((stream gzip-stream) &key abort)
Package

uk.co.deoxybyte-io.

Source

gzip-stream.lisp.

Method: stream-element-type ((stream gzip-line-input-stream))
Source

line-stream.lisp.

Method: stream-element-type ((stream gzip-stream))
Source

gzip-stream.lisp.

Method: stream-file-position ((stream gzip-line-input-stream) &optional position)
Package

sb-gray.

Source

line-stream.lisp.

Method: stream-file-position ((stream gzip-stream) &optional position)
Package

sb-gray.

Source

gzip-stream.lisp.

Method: stream-finish-output ((stream gzip-output-stream))
Package

sb-gray.

Source

gzip-stream.lisp.

Method: stream-force-output ((stream gzip-output-stream))
Package

sb-gray.

Source

gzip-stream.lisp.

Method: stream-read-byte ((stream gzip-input-stream))
Package

sb-gray.

Source

gzip-stream.lisp.

Method: stream-read-line ((stream gzip-line-input-stream))
Package

sb-gray.

Source

line-stream.lisp.

Method: stream-read-sequence ((stream gzip-line-input-stream) sequence &optional start end)
Package

sb-gray.

Source

line-stream.lisp.

Method: stream-read-sequence ((stream gzip-input-stream) (seq sequence) &optional start end)
Package

sb-gray.

Source

sbcl.lisp.

Method: stream-write-byte ((stream gzip-output-stream) (byte fixnum))
Package

sb-gray.

Source

gzip-stream.lisp.

Method: stream-write-sequence ((stream gzip-output-stream) (seq sequence) &optional start end)
Package

sb-gray.

Source

sbcl.lisp.


6.1.6 Conditions

Condition: gz-io-error

A condition raised when a gzip error occurs.

Package

uk.co.deoxybyte-gzip.

Source

conditions.lisp.

Direct superclasses
Condition: zlib-error

A condition raised when a zlib error occurs.

Package

uk.co.deoxybyte-gzip.

Source

conditions.lisp.

Direct superclasses
  • error.
  • simple-text-condition.
Direct subclasses

gz-io-error.

Direct methods

errno-of.

Direct slots
Slot: errno

The C error number.

Initform

(quote nil)

Initargs

:errno

Readers

errno-of.

Writers

This slot is read-only.


Next: , Previous: , Up: Public Interface   [Contents][Index]

6.1.7 Structures

Structure: gz

A gzip handle.

- ptr: A foreign pointer to a zlib struct.
- open-p: A flag that, while T, indicates that the foreign pointer may be freed.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: ptr
Readers

gz-ptr.

Writers

(setf gz-ptr).

Slot: open-p
Readers

gz-open-p.

Writers

(setf gz-open-p).

Structure: gz-member

A gzip member as defined by RFC1952.

- id1: IDentification 1.
- id2: IDentification 2.
- cm: Compression Method.
- flg: FLaGs.
- mtime: Modification TIME.
- xfl: eXtra FLags.
- os: Operating System.
- xlen: eXtra LENgth.
- isize: Input SIZE.
- crc32: CRC-32.
- cdata: Compressed DATA.
- cend: Compressed data END. The length of compressed data in cdata, starting at index 0, if cdata is only partially filled.

Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: id1
Type

uk.co.deoxybyte-utilities:uint8

Initform

uk.co.deoxybyte-gzip:+id1+

Readers

gz-member-id1.

Writers

This slot is read-only.

Slot: id2
Type

uk.co.deoxybyte-utilities:uint8

Initform

uk.co.deoxybyte-gzip:+id2+

Readers

gz-member-id2.

Writers

This slot is read-only.

Slot: cm
Type

uk.co.deoxybyte-utilities:uint8

Initform

uk.co.deoxybyte-gzip:+cm-deflate+

Readers

gz-member-cm.

Writers

This slot is read-only.

Slot: flg
Type

uk.co.deoxybyte-utilities:uint8

Initform

uk.co.deoxybyte-gzip:+flag-extra+

Readers

gz-member-flg.

Writers

(setf gz-member-flg).

Slot: mtime
Type

uk.co.deoxybyte-utilities:uint32

Initform

0

Readers

gz-member-mtime.

Writers

(setf gz-member-mtime).

Slot: xfl
Type

uk.co.deoxybyte-utilities:uint8

Initform

0

Readers

gz-member-xfl.

Writers

(setf gz-member-xfl).

Slot: os
Type

uk.co.deoxybyte-utilities:uint8

Initform

uk.co.deoxybyte-gzip:+os-unknown+

Readers

gz-member-os.

Writers

(setf gz-member-os).

Slot: xlen
Type

uk.co.deoxybyte-utilities:uint16

Initform

0

Readers

gz-member-xlen.

Writers

(setf gz-member-xlen).

Slot: isize
Type

uk.co.deoxybyte-utilities:uint32

Initform

0

Readers

gz-member-isize.

Writers

(setf gz-member-isize).

Slot: crc32
Type

uk.co.deoxybyte-utilities:uint32

Initform

0

Readers

gz-member-crc32.

Writers

(setf gz-member-crc32).

Slot: cdata
Type

uk.co.deoxybyte-utilities:simple-octet-vector

Initform

(make-array 0 :element-type (quote uk.co.deoxybyte-utilities:octet))

Readers

gz-member-cdata.

Writers

(setf gz-member-cdata).

Slot: cend
Type

uk.co.deoxybyte-utilities:uint32

Initform

0

Readers

gz-member-cend.

Writers

(setf gz-member-cend).


Previous: , Up: Public Interface   [Contents][Index]

6.1.8 Classes

Class: gzip-input-stream

A stream that reads bytes from a compressed stream.

Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.

Direct superclasses
Direct methods
Class: gzip-line-input-stream
Package

uk.co.deoxybyte-gzip.

Source

line-stream.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: buffer

The buffer from which lines are read.

Initform

(make-array uk.co.deoxybyte-gzip::+octet-buffer-size+ :element-type (quote uk.co.deoxybyte-utilities:octet) :initial-element 0)

Initargs

:buffer

Slot: eol-code

The end of line character code. If two characters are used, this is the first of the pair.

Initform

(char-code #\newline)

Initargs

:eol-code

Slot: num-bytes

The number of bytes that were read into the buffer from the stream.

Initform

0

Slot: offset

The offset in the byte buffer from which the next byte is to be read.

Initform

0

Slot: filespec
Initargs

:filespec

Slot: gz
Initargs

:gz

Class: gzip-output-stream

A stream that writes characters to a compressed stream.

Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.

Direct superclasses
Direct methods
Class: gzip-stream

A gzip stream capable of reading or writing compressed data.

Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.

Direct superclasses

fundamental-stream.

Direct subclasses
Direct methods
Direct slots
Slot: gz

The gzip handle.

Initargs

:gz

Slot: buffer
Initform

(make-array uk.co.deoxybyte-gzip::+octet-buffer-size+ :element-type (quote uk.co.deoxybyte-utilities:octet) :initial-element (char-code #\.))

Initargs

:buffer

Slot: open-stream-p
Package

common-lisp.

Initform

t


6.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.1 Constants

Constant: +default-zlib-buffer-size+
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Constant: +octet-buffer-size+
Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.

Constant: +z-best-compression+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-best-speed+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-no-compression+
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Constant: +z-sync-flush+
Package

zlib-ffi.

Source

zlib-ffi.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.2 Ordinary functions

Function: %line-stream-read-sequence (stream sequence start end)
Package

uk.co.deoxybyte-gzip.

Source

line-stream.lisp.

Function: %line-stream-write-sequence (stream sequence start end)
Package

uk.co.deoxybyte-gzip.

Source

line-stream.lisp.

Function: %stream-read-sequence (stream seq &optional start end)
Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.

Function: %stream-write-sequence (stream seq &optional start end)
Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.

Function: %var-accessor-*c-error-number* ()
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: (setf %var-accessor-*c-error-number*) ()
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Function: copy-gz (instance)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: copy-gz-member (instance)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Function: empty-to-stream (buffer stream n)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: fill-from-stream (buffer stream n)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-error (gz &optional errno message)

Raises a {define-condition gz-io-error} . An ERRNO integer and MESSAGE string may be supplied. If ERRNO or MESSAGE are T, they are retrieved using *C-ERROR-NUMBER* and {defun gz-error-message} respectively.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-error-message (gz)

Returns a zlib error message string relevant to GZ.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-flush (gz flush-mode)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-member-p (object)
Package

uk.co.deoxybyte-gzip.

Source

rfc1952.lisp.

Reader: gz-open-p (instance)
Writer: (setf gz-open-p) (instance)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Target Slot

open-p.

Function: gz-p (object)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Reader: gz-ptr (instance)
Writer: (setf gz-ptr) (instance)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Target Slot

ptr.

Function: gz-seek (gz offset)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: gz-tell (gz)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: make-gz (&key ptr open-p)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: make-z-stream ()

Makes an returns a new Z-STREAM with the ZALLOC, ZFREE and OPAQUE slots filled with null-pointers.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: read-octet-line (stream)

Reads chunks of bytes up to the next newline or end of stream, returning them in a list. The newline is not included. Returns two values - a list of chunks and either NIL or T to indicate whether a terminating newline was missing. When the stream underlying the buffer is exhausted the list of chunks will be empty.

Package

uk.co.deoxybyte-gzip.

Source

line-stream.lisp.

Function: z-error (errno &optional message)

Raises a {define-condition zlib-error} . A MESSAGE string may be supplied, otherwise it will be determined from ERRNO.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: z-stream-close (z-stream operation)

Signals the end of OPERATION (:inflate or :deflate) on Z-STREAM and frees the Z-STREAM memory.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: z-stream-open (operation &key compression suppress-header gzip-format window-bits mem-level strategy)

Returns a new Z-STREAM initialised for OPERATION (:inflate or :deflate).

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: z-stream-operation (operation source dest input-fn output-fn buffer-size &rest z-stream-args)

Implements Zlib compression/decompression using inflate/deflate on Lisp streams, as described in the Zlib Usage Example.

Arguments:

- operation (symbol): The operation type, either :inflate or :deflate . - source (stream): A Lisp octet input stream.
- dest (stream): A Lisp octet output stream.
- input-fn (function): A Lisp function that accepts 3 arguments, an input stream, a buffer and an integer n. The function must read up to n bytes from the input stream into the buffer and return the number of bytes read.
- output-fn (function): A Lisp function that accepts 3 arguments, an output stream, a buffer and an integer n. The function must write up to n bytes to the output stream into the buffer and return the number of bytes written.
- buffer-size (fixnum): The size of the buffer used in the compression/decompression step(s).

Rest:
- Keyword arguments passed to {defun z-stream-open} .
See {defun z-stream-open}

Returns:
- Number of bytes read.
- Number of bytes written.

Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.

Function: z-vector-operation (operation source dest backoff &rest z-stream-args)
Package

uk.co.deoxybyte-gzip.

Source

deoxybyte-gzip.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.3 Generic functions

Generic Reader: errno-of (condition)
Package

uk.co.deoxybyte-gzip.

Methods
Reader Method: errno-of ((condition zlib-error))
Source

conditions.lisp.

Target Slot

errno.

Generic Function: stream-delete-file (stream)
Package

uk.co.deoxybyte-gzip.

Methods
Method: stream-delete-file ((stream gzip-line-input-stream))
Source

line-stream.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.4 Classes

Class: z-stream-tclass
Package

zlib-ffi.

Source

zlib-ffi.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Previous: , Up: Internals   [Contents][Index]

6.2.5 Types

Type: octet-buffer ()
Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.

Type: octet-buffer-index ()
Package

uk.co.deoxybyte-gzip.

Source

gzip-stream.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   C   D   E   F   G   I   M   O   R   S   U   W   Z  
Index Entry  Section

%
%adler32: Public ordinary functions
%compress: Public ordinary functions
%compress2: Public ordinary functions
%crc32: Public ordinary functions
%deflate: Public ordinary functions
%deflate-init: Public ordinary functions
%deflate-init2: Public ordinary functions
%inflate: Public ordinary functions
%inflate-init: Public ordinary functions
%inflate-init2: Public ordinary functions
%line-stream-read-sequence: Private ordinary functions
%line-stream-write-sequence: Private ordinary functions
%stream-read-sequence: Private ordinary functions
%stream-write-sequence: Private ordinary functions
%uncompress: Public ordinary functions
%var-accessor-*c-error-number*: Private ordinary functions

(
(setf %var-accessor-*c-error-number*): Private ordinary functions
(setf gz-member-cdata): Public ordinary functions
(setf gz-member-cend): Public ordinary functions
(setf gz-member-crc32): Public ordinary functions
(setf gz-member-flg): Public ordinary functions
(setf gz-member-isize): Public ordinary functions
(setf gz-member-mtime): Public ordinary functions
(setf gz-member-os): Public ordinary functions
(setf gz-member-xfl): Public ordinary functions
(setf gz-member-xlen): Public ordinary functions
(setf gz-open-p): Private ordinary functions
(setf gz-ptr): Private ordinary functions

A
adler32: Public ordinary functions

C
compress: Public ordinary functions
copy-gz: Private ordinary functions
copy-gz-member: Private ordinary functions
crc32: Public ordinary functions

D
deflate-end: Public ordinary functions
deflate-init: Public macros
deflate-init2: Public macros
deflate-reset: Public ordinary functions
deflate-stream: Public ordinary functions
deflate-vector: Public ordinary functions

E
empty-to-stream: Private ordinary functions
errno-of: Private generic functions
errno-of: Private generic functions

F
fill-from-stream: Private ordinary functions
Function, %adler32: Public ordinary functions
Function, %compress: Public ordinary functions
Function, %compress2: Public ordinary functions
Function, %crc32: Public ordinary functions
Function, %deflate: Public ordinary functions
Function, %deflate-init: Public ordinary functions
Function, %deflate-init2: Public ordinary functions
Function, %inflate: Public ordinary functions
Function, %inflate-init: Public ordinary functions
Function, %inflate-init2: Public ordinary functions
Function, %line-stream-read-sequence: Private ordinary functions
Function, %line-stream-write-sequence: Private ordinary functions
Function, %stream-read-sequence: Private ordinary functions
Function, %stream-write-sequence: Private ordinary functions
Function, %uncompress: Public ordinary functions
Function, %var-accessor-*c-error-number*: Private ordinary functions
Function, (setf %var-accessor-*c-error-number*): Private ordinary functions
Function, (setf gz-member-cdata): Public ordinary functions
Function, (setf gz-member-cend): Public ordinary functions
Function, (setf gz-member-crc32): Public ordinary functions
Function, (setf gz-member-flg): Public ordinary functions
Function, (setf gz-member-isize): Public ordinary functions
Function, (setf gz-member-mtime): Public ordinary functions
Function, (setf gz-member-os): Public ordinary functions
Function, (setf gz-member-xfl): Public ordinary functions
Function, (setf gz-member-xlen): Public ordinary functions
Function, (setf gz-open-p): Private ordinary functions
Function, (setf gz-ptr): Private ordinary functions
Function, adler32: Public ordinary functions
Function, compress: Public ordinary functions
Function, copy-gz: Private ordinary functions
Function, copy-gz-member: Private ordinary functions
Function, crc32: Public ordinary functions
Function, deflate-end: Public ordinary functions
Function, deflate-reset: Public ordinary functions
Function, deflate-stream: Public ordinary functions
Function, deflate-vector: Public ordinary functions
Function, empty-to-stream: Private ordinary functions
Function, fill-from-stream: Private ordinary functions
Function, gunzip: Public ordinary functions
Function, gunzip-pathname: Public ordinary functions
Function, gz-close: Public ordinary functions
Function, gz-eof-p: Public ordinary functions
Function, gz-error: Private ordinary functions
Function, gz-error-message: Private ordinary functions
Function, gz-flush: Private ordinary functions
Function, gz-member-cdata: Public ordinary functions
Function, gz-member-cend: Public ordinary functions
Function, gz-member-cm: Public ordinary functions
Function, gz-member-crc32: Public ordinary functions
Function, gz-member-flg: Public ordinary functions
Function, gz-member-id1: Public ordinary functions
Function, gz-member-id2: Public ordinary functions
Function, gz-member-isize: Public ordinary functions
Function, gz-member-mtime: Public ordinary functions
Function, gz-member-os: Public ordinary functions
Function, gz-member-p: Private ordinary functions
Function, gz-member-xfl: Public ordinary functions
Function, gz-member-xlen: Public ordinary functions
Function, gz-open: Public ordinary functions
Function, gz-open-p: Private ordinary functions
Function, gz-p: Private ordinary functions
Function, gz-ptr: Private ordinary functions
Function, gz-read: Public ordinary functions
Function, gz-read-byte: Public ordinary functions
Function, gz-read-string: Public ordinary functions
Function, gz-seek: Private ordinary functions
Function, gz-tell: Private ordinary functions
Function, gz-write: Public ordinary functions
Function, gz-write-byte: Public ordinary functions
Function, gz-write-string: Public ordinary functions
Function, gzclose: Public ordinary functions
Function, gzdopen: Public ordinary functions
Function, gzeof: Public ordinary functions
Function, gzerror: Public ordinary functions
Function, gzflush: Public ordinary functions
Function, gzgetc: Public ordinary functions
Function, gzgets: Public ordinary functions
Function, gzip: Public ordinary functions
Function, gzip-open: Public ordinary functions
Function, gzip-pathname: Public ordinary functions
Function, gzopen: Public ordinary functions
Function, gzputc: Public ordinary functions
Function, gzputs: Public ordinary functions
Function, gzread: Public ordinary functions
Function, gzseek: Public ordinary functions
Function, gztell: Public ordinary functions
Function, gzwrite: Public ordinary functions
Function, inflate-end: Public ordinary functions
Function, inflate-reset: Public ordinary functions
Function, inflate-stream: Public ordinary functions
Function, inflate-vector: Public ordinary functions
Function, make-gz: Private ordinary functions
Function, make-gz-member: Public ordinary functions
Function, make-z-stream: Private ordinary functions
Function, read-octet-line: Private ordinary functions
Function, uncompress: Public ordinary functions
Function, z-error: Private ordinary functions
Function, z-stream-close: Private ordinary functions
Function, z-stream-open: Private ordinary functions
Function, z-stream-operation: Private ordinary functions
Function, z-vector-operation: Private ordinary functions
Function, zlib-version: Public ordinary functions

G
Generic Function, errno-of: Private generic functions
Generic Function, stream-delete-file: Private generic functions
gunzip: Public ordinary functions
gunzip-pathname: Public ordinary functions
gz-close: Public ordinary functions
gz-eof-p: Public ordinary functions
gz-error: Private ordinary functions
gz-error-message: Private ordinary functions
gz-flush: Private ordinary functions
gz-member-cdata: Public ordinary functions
gz-member-cend: Public ordinary functions
gz-member-cm: Public ordinary functions
gz-member-crc32: Public ordinary functions
gz-member-flg: Public ordinary functions
gz-member-id1: Public ordinary functions
gz-member-id2: Public ordinary functions
gz-member-isize: Public ordinary functions
gz-member-mtime: Public ordinary functions
gz-member-os: Public ordinary functions
gz-member-p: Private ordinary functions
gz-member-xfl: Public ordinary functions
gz-member-xlen: Public ordinary functions
gz-open: Public ordinary functions
gz-open-p: Private ordinary functions
gz-p: Private ordinary functions
gz-ptr: Private ordinary functions
gz-read: Public ordinary functions
gz-read-byte: Public ordinary functions
gz-read-string: Public ordinary functions
gz-seek: Private ordinary functions
gz-tell: Private ordinary functions
gz-write: Public ordinary functions
gz-write-byte: Public ordinary functions
gz-write-string: Public ordinary functions
gzclose: Public ordinary functions
gzdopen: Public ordinary functions
gzeof: Public ordinary functions
gzerror: Public ordinary functions
gzflush: Public ordinary functions
gzgetc: Public ordinary functions
gzgets: Public ordinary functions
gzip: Public ordinary functions
gzip-open: Public ordinary functions
gzip-pathname: Public ordinary functions
gzopen: Public ordinary functions
gzputc: Public ordinary functions
gzputs: Public ordinary functions
gzread: Public ordinary functions
gzseek: Public ordinary functions
gztell: Public ordinary functions
gzwrite: Public ordinary functions

I
inflate-end: Public ordinary functions
inflate-init: Public macros
inflate-init2: Public macros
inflate-reset: Public ordinary functions
inflate-stream: Public ordinary functions
inflate-vector: Public ordinary functions

M
Macro, deflate-init: Public macros
Macro, deflate-init2: Public macros
Macro, inflate-init: Public macros
Macro, inflate-init2: Public macros
Macro, with-gz-file: Public macros
Macro, with-open-gzip: Public macros
make-gz: Private ordinary functions
make-gz-member: Public ordinary functions
make-z-stream: Private ordinary functions
Method, errno-of: Private generic functions
Method, more-lines-p: Public standalone methods
Method, open-stream-p: Public standalone methods
Method, stream-clear-input: Public standalone methods
Method, stream-clear-input: Public standalone methods
Method, stream-clear-output: Public standalone methods
Method, stream-close: Public standalone methods
Method, stream-delete-file: Private generic functions
Method, stream-element-type: Public standalone methods
Method, stream-element-type: Public standalone methods
Method, stream-file-position: Public standalone methods
Method, stream-file-position: Public standalone methods
Method, stream-finish-output: Public standalone methods
Method, stream-force-output: Public standalone methods
Method, stream-read-byte: Public standalone methods
Method, stream-read-line: Public standalone methods
Method, stream-read-sequence: Public standalone methods
Method, stream-read-sequence: Public standalone methods
Method, stream-write-byte: Public standalone methods
Method, stream-write-sequence: Public standalone methods
more-lines-p: Public standalone methods

O
open-stream-p: Public standalone methods

R
read-octet-line: Private ordinary functions

S
stream-clear-input: Public standalone methods
stream-clear-input: Public standalone methods
stream-clear-output: Public standalone methods
stream-close: Public standalone methods
stream-delete-file: Private generic functions
stream-delete-file: Private generic functions
stream-element-type: Public standalone methods
stream-element-type: Public standalone methods
stream-file-position: Public standalone methods
stream-file-position: Public standalone methods
stream-finish-output: Public standalone methods
stream-force-output: Public standalone methods
stream-read-byte: Public standalone methods
stream-read-line: Public standalone methods
stream-read-sequence: Public standalone methods
stream-read-sequence: Public standalone methods
stream-write-byte: Public standalone methods
stream-write-sequence: Public standalone methods

U
uncompress: Public ordinary functions

W
with-gz-file: Public macros
with-open-gzip: Public macros

Z
z-error: Private ordinary functions
z-stream-close: Private ordinary functions
z-stream-open: Private ordinary functions
z-stream-operation: Private ordinary functions
z-vector-operation: Private ordinary functions
zlib-version: Public ordinary functions

Jump to:   %   (  
A   C   D   E   F   G   I   M   O   R   S   U   W   Z  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
B   C   E   F   G   I   M   N   O   P   S   X  
Index Entry  Section

*
*c-error-number*: Public symbol macros

+
+cm-deflate+: Public constants
+default-zlib-buffer-size+: Private constants
+flag-comment+: Public constants
+flag-extra+: Public constants
+flag-fhcrc+: Public constants
+flag-name+: Public constants
+flag-text+: Public constants
+id1+: Public constants
+id2+: Public constants
+octet-buffer-size+: Private constants
+os-acorn-riscos+: Public constants
+os-amiga+: Public constants
+os-atari-tos+: Public constants
+os-cp/m+: Public constants
+os-fat-filesystem+: Public constants
+os-hpfs-filesystem+: Public constants
+os-macintosh+: Public constants
+os-ntfs-filesystem+: Public constants
+os-qdos+: Public constants
+os-tops-20+: Public constants
+os-unix+: Public constants
+os-unknown+: Public constants
+os-vm/cms+: Public constants
+os-vms+: Public constants
+os-z-system+: Public constants
+xfl-fastest+: Public constants
+xfl-slowest+: Public constants
+z-best-compression+: Private constants
+z-best-speed+: Private constants
+z-buf-error+: Public constants
+z-data-error+: Public constants
+z-default-compression+: Public constants
+z-default-strategy+: Public constants
+z-deflated+: Public constants
+z-errno+: Public constants
+z-filtered+: Public constants
+z-finish+: Public constants
+z-full-flush+: Public constants
+z-huffman-only+: Public constants
+z-mem-error+: Public constants
+z-need-dict+: Public constants
+z-no-compression+: Private constants
+z-no-flush+: Public constants
+z-null+: Public constants
+z-ok+: Public constants
+z-stream-end+: Public constants
+z-stream-error+: Public constants
+z-sync-flush+: Private constants
+z-version-error+: Public constants

B
buffer: Public classes
buffer: Public classes

C
cdata: Public structures
cend: Public structures
cm: Public structures
Constant, +cm-deflate+: Public constants
Constant, +default-zlib-buffer-size+: Private constants
Constant, +flag-comment+: Public constants
Constant, +flag-extra+: Public constants
Constant, +flag-fhcrc+: Public constants
Constant, +flag-name+: Public constants
Constant, +flag-text+: Public constants
Constant, +id1+: Public constants
Constant, +id2+: Public constants
Constant, +octet-buffer-size+: Private constants
Constant, +os-acorn-riscos+: Public constants
Constant, +os-amiga+: Public constants
Constant, +os-atari-tos+: Public constants
Constant, +os-cp/m+: Public constants
Constant, +os-fat-filesystem+: Public constants
Constant, +os-hpfs-filesystem+: Public constants
Constant, +os-macintosh+: Public constants
Constant, +os-ntfs-filesystem+: Public constants
Constant, +os-qdos+: Public constants
Constant, +os-tops-20+: Public constants
Constant, +os-unix+: Public constants
Constant, +os-unknown+: Public constants
Constant, +os-vm/cms+: Public constants
Constant, +os-vms+: Public constants
Constant, +os-z-system+: Public constants
Constant, +xfl-fastest+: Public constants
Constant, +xfl-slowest+: Public constants
Constant, +z-best-compression+: Private constants
Constant, +z-best-speed+: Private constants
Constant, +z-buf-error+: Public constants
Constant, +z-data-error+: Public constants
Constant, +z-default-compression+: Public constants
Constant, +z-default-strategy+: Public constants
Constant, +z-deflated+: Public constants
Constant, +z-errno+: Public constants
Constant, +z-filtered+: Public constants
Constant, +z-finish+: Public constants
Constant, +z-full-flush+: Public constants
Constant, +z-huffman-only+: Public constants
Constant, +z-mem-error+: Public constants
Constant, +z-need-dict+: Public constants
Constant, +z-no-compression+: Private constants
Constant, +z-no-flush+: Public constants
Constant, +z-null+: Public constants
Constant, +z-ok+: Public constants
Constant, +z-stream-end+: Public constants
Constant, +z-stream-error+: Public constants
Constant, +z-sync-flush+: Private constants
Constant, +z-version-error+: Public constants
crc32: Public structures

E
eol-code: Public classes
errno: Public conditions

F
filespec: Public classes
flg: Public structures

G
gz: Public classes
gz: Public classes

I
id1: Public structures
id2: Public structures
isize: Public structures

M
mtime: Public structures

N
num-bytes: Public classes

O
offset: Public classes
open-p: Public structures
open-stream-p: Public classes
os: Public structures

P
ptr: Public structures

S
Slot, buffer: Public classes
Slot, buffer: Public classes
Slot, cdata: Public structures
Slot, cend: Public structures
Slot, cm: Public structures
Slot, crc32: Public structures
Slot, eol-code: Public classes
Slot, errno: Public conditions
Slot, filespec: Public classes
Slot, flg: Public structures
Slot, gz: Public classes
Slot, gz: Public classes
Slot, id1: Public structures
Slot, id2: Public structures
Slot, isize: Public structures
Slot, mtime: Public structures
Slot, num-bytes: Public classes
Slot, offset: Public classes
Slot, open-p: Public structures
Slot, open-stream-p: Public classes
Slot, os: Public structures
Slot, ptr: Public structures
Slot, xfl: Public structures
Slot, xlen: Public structures
Symbol Macro, *c-error-number*: Public symbol macros

X
xfl: Public structures
xlen: Public structures

Jump to:   *   +  
B   C   E   F   G   I   M   N   O   P   S   X  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   F   G   L   M   O   P   R   S   T   U   Z  
Index Entry  Section

C
Class, gzip-input-stream: Public classes
Class, gzip-line-input-stream: Public classes
Class, gzip-output-stream: Public classes
Class, gzip-stream: Public classes
Class, z-stream-tclass: Private classes
Condition, gz-io-error: Public conditions
Condition, zlib-error: Public conditions
conditions.lisp: The deoxybyte-gzip/deoxybyte-gzip/conditions․lisp file

D
deoxybyte-gzip: The deoxybyte-gzip system
deoxybyte-gzip: The deoxybyte-gzip/deoxybyte-gzip module
deoxybyte-gzip.asd: The deoxybyte-gzip/deoxybyte-gzip․asd file
deoxybyte-gzip.lisp: The deoxybyte-gzip/deoxybyte-gzip/deoxybyte-gzip․lisp file

F
File, conditions.lisp: The deoxybyte-gzip/deoxybyte-gzip/conditions․lisp file
File, deoxybyte-gzip.asd: The deoxybyte-gzip/deoxybyte-gzip․asd file
File, deoxybyte-gzip.lisp: The deoxybyte-gzip/deoxybyte-gzip/deoxybyte-gzip․lisp file
File, gzip-stream.lisp: The deoxybyte-gzip/deoxybyte-gzip/gzip-stream․lisp file
File, line-stream.lisp: The deoxybyte-gzip/deoxybyte-gzip/line-stream․lisp file
File, package.lisp: The deoxybyte-gzip/deoxybyte-gzip/package․lisp file
File, rfc1952.lisp: The deoxybyte-gzip/deoxybyte-gzip/rfc1952․lisp file
File, sbcl.lisp: The deoxybyte-gzip/deoxybyte-gzip/sbcl․lisp file
File, zlib-ffi.lisp: The deoxybyte-gzip/deoxybyte-gzip/zlib-ffi․lisp file

G
gz: Public structures
gz-io-error: Public conditions
gz-member: Public structures
gzip-input-stream: Public classes
gzip-line-input-stream: Public classes
gzip-output-stream: Public classes
gzip-stream: Public classes
gzip-stream.lisp: The deoxybyte-gzip/deoxybyte-gzip/gzip-stream․lisp file

L
line-stream.lisp: The deoxybyte-gzip/deoxybyte-gzip/line-stream․lisp file

M
Module, deoxybyte-gzip: The deoxybyte-gzip/deoxybyte-gzip module

O
octet-buffer: Private types
octet-buffer-index: Private types

P
Package, uk.co.deoxybyte-gzip: The uk․co․deoxybyte-gzip package
Package, zlib-ffi: The zlib-ffi package
package.lisp: The deoxybyte-gzip/deoxybyte-gzip/package․lisp file

R
rfc1952.lisp: The deoxybyte-gzip/deoxybyte-gzip/rfc1952․lisp file

S
sbcl.lisp: The deoxybyte-gzip/deoxybyte-gzip/sbcl․lisp file
Structure, gz: Public structures
Structure, gz-member: Public structures
System, deoxybyte-gzip: The deoxybyte-gzip system

T
Type, octet-buffer: Private types
Type, octet-buffer-index: Private types

U
uk.co.deoxybyte-gzip: The uk․co․deoxybyte-gzip package

Z
z-stream-tclass: Private classes
zlib-error: Public conditions
zlib-ffi: The zlib-ffi package
zlib-ffi.lisp: The deoxybyte-gzip/deoxybyte-gzip/zlib-ffi․lisp file

Jump to:   C   D   F   G   L   M   O   P   R   S   T   U   Z