The deoxybyte-gzip Reference Manual

Table of Contents

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 3.0 "Montgomery Scott" on Mon Dec 02 10:08:01 2019 GMT+0.


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

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/


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

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
Source

deoxybyte-gzip.asd (file)

Component

deoxybyte-gzip (module)


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

3 Modules

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


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

3.1 deoxybyte-gzip/deoxybyte-gzip

Parent

deoxybyte-gzip (system)

Location

src/

Components

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

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


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 deoxybyte-gzip.asd

Location

deoxybyte-gzip.asd

Systems

deoxybyte-gzip (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

deoxybyte-gzip (module)

Location

src/package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

package.lisp (file)

Parent

deoxybyte-gzip (module)

Location

src/zlib-ffi.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

zlib-ffi.lisp (file)

Parent

deoxybyte-gzip (module)

Location

src/rfc1952.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

rfc1952.lisp (file)

Parent

deoxybyte-gzip (module)

Location

src/conditions.lisp

Exported Definitions
Internal Definitions

errno-of (method)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

conditions.lisp (file)

Parent

deoxybyte-gzip (module)

Location

src/deoxybyte-gzip.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

deoxybyte-gzip.lisp (file)

Parent

deoxybyte-gzip (module)

Location

src/gzip-stream.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

gzip-stream.lisp (file)

Parent

deoxybyte-gzip (module)

Location

src/line-stream.lisp

Exported Definitions

gzip-line-input-stream (class)

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

line-stream.lisp (file)

Parent

deoxybyte-gzip (module)

Location

src/sbcl.lisp


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

5 Packages

Packages are listed by definition order.


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

5.1 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 (file)

Nicknames
Use List
Exported Definitions
Internal Definitions

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

5.2 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 (file)

Use List
Used By List

uk.co.deoxybyte-gzip

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Constants

Constant: +cm-deflate+

CM (Compression Method)

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +flag-comment+

FLG (FLaGs) FCOMMENT

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +flag-extra+

FLG (FLaGs) FEXTRA

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +flag-fhcrc+

FLG (FLaGs) FHCRC

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +flag-name+

FLG (FLaGs) FNAME

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +flag-text+

FLG (FLaGs) FTEXT

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +id1+

ID1 (IDentification 1)

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +id2+

ID2 (IDentification 2)

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-acorn-riscos+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-amiga+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-atari-tos+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-cp/m+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-fat-filesystem+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-hpfs-filesystem+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-macintosh+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-ntfs-filesystem+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-qdos+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-tops-20+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-unix+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-unknown+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-vm/cms+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-vms+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +os-z-system+
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +xfl-fastest+

XFL (eXtra FLags) compressor used fastest algorithm

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +xfl-slowest+

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

Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Constant: +z-buf-error+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-data-error+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-default-compression+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-default-strategy+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-deflated+

Compression method

Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-errno+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-filtered+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-finish+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-full-flush+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-huffman-only+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-mem-error+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-need-dict+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-no-flush+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-null+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-ok+

No error.

Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-stream-end+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-stream-error+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-version-error+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Symbol macros

Symbol Macro: *c-error-number*
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Expansion

(zlib-ffi::%var-accessor-*c-error-number*)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Macros

Macro: deflate-init STRM LEVEL

Macro that emulates Zlib’s deflateInit.

Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Macro: deflate-init2 STRM LEVEL METHOD WINDOW-BITS MEM-LEVEL STRATEGY

Macro that emulates Zlib’s deflateInit2.

Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Macro: inflate-init STRM

Macro that emulates Zlib’s inflateInit.

Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Macro: inflate-init2 STRM WINDOW-BITS

Macro that emulates Zlib’s inflateInit2.

Package

zlib-ffi

Source

zlib-ffi.lisp (file)

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 (file)

Macro: with-open-gzip (VAR FILESPEC &rest ARGS) &body BODY
Package

uk.co.deoxybyte-gzip

Source

gzip-stream.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Functions

Function: %adler32 ADLER BYTES LEN
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %compress DEST DESTLEN SOURCE SOURCELEN
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %compress2 DEST DESTLEN SOURCE SOURCELEN LEVEL
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %crc32 CRC BYTES LEN
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %deflate STRM FLUSH
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %deflate-init STRM LEVEL VERSION STRM-SIZE
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %deflate-init2 STRM LEVEL METHOD WINDOW-BITS MEM-LEVEL STRATEGY VERSION STRM-SIZE
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %inflate STRM FLUSH
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %inflate-init STRM VERSION STRM-SIZE
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %inflate-init2 STRM WINDOW-BITS VERSION STRM-SIZE
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: %uncompress DEST DESTLEN SOURCE SOURCELEN
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: adler32 BUFFER &key START END ADLER32
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

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 (file)

Function: crc32 BUFFER &key START END CRC32
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: deflate-end STRM
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: deflate-reset STRM
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: gz-close GZ

Closes GZ, if open.

Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: gz-eof-p GZ

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

Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: gz-member-cdata INSTANCE
Function: (setf gz-member-cdata) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-cend INSTANCE
Function: (setf gz-member-cend) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-cm INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-crc32 INSTANCE
Function: (setf gz-member-crc32) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-flg INSTANCE
Function: (setf gz-member-flg) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-id1 INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-id2 INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-isize INSTANCE
Function: (setf gz-member-isize) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-mtime INSTANCE
Function: (setf gz-member-mtime) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-os INSTANCE
Function: (setf gz-member-os) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-xfl INSTANCE
Function: (setf gz-member-xfl) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-member-xlen INSTANCE
Function: (setf gz-member-xlen) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

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 (file)

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 (file)

Function: gz-read-byte GZ

Returns a byte read from GZ, or :eof .

Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

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 (file)

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 (file)

Function: gz-write-byte GZ BYTE

Writes BYTE to GZ and returns BYTE.

Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

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 (file)

Function: gzclose GZ
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzdopen FD MODE
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzeof GZ
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzerror GZ ERRNUM
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzflush GZ FLUSH
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzgetc GZ
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzgets GZ BUF LEN
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

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 (file)

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 (file)

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 (file)

Function: gzopen PATH MODE
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzputc GZ CHAR
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzputs GZ STR
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzread GZ BUF LEN
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzseek GZ OFFSET WHENCE
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gztell GZ
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: gzwrite GZ BUF LEN
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: inflate-end STRM
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: inflate-reset STRM
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

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 (file)

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 (file)

Function: make-gz-member &key (ID1 ID1) (ID2 ID2) (CM CM) (FLG FLG) (MTIME MTIME) (XFL XFL) (OS OS) (XLEN XLEN) (ISIZE ISIZE) (CRC32 CRC32) (CDATA CDATA) (CEND CEND)
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

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 (file)

Function: zlib-version ()
Package

zlib-ffi

Source

zlib-ffi.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Conditions

Condition: gz-io-error ()

A condition raised when a gzip error occurs.

Package

uk.co.deoxybyte-gzip

Source

conditions.lisp (file)

Direct superclasses
Condition: zlib-error ()

A condition raised when a zlib error occurs.

Package

uk.co.deoxybyte-gzip

Source

conditions.lisp (file)

Direct superclasses
  • simple-text-condition (condition)
  • error (condition)
Direct subclasses

gz-io-error (condition)

Direct methods

errno-of (method)

Direct slots
Slot: errno

The C error number.

Initargs

:errno

Initform

(quote nil)

Readers

errno-of (generic function)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.6 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 (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: ptr
Readers

gz-ptr (function)

Writers

(setf gz-ptr) (function)

Slot: open-p
Readers

gz-open-p (function)

Writers

(setf gz-open-p) (function)

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 (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: id1
Type

uk.co.deoxybyte-utilities:uint8

Initform

uk.co.deoxybyte-gzip:+id1+

Readers

gz-member-id1 (function)

Writers

(setf gz-member-id1) (function)

Slot: id2
Type

uk.co.deoxybyte-utilities:uint8

Initform

uk.co.deoxybyte-gzip:+id2+

Readers

gz-member-id2 (function)

Writers

(setf gz-member-id2) (function)

Slot: cm
Type

uk.co.deoxybyte-utilities:uint8

Initform

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

Readers

gz-member-cm (function)

Writers

(setf gz-member-cm) (function)

Slot: flg
Type

uk.co.deoxybyte-utilities:uint8

Initform

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

Readers

gz-member-flg (function)

Writers

(setf gz-member-flg) (function)

Slot: mtime
Type

uk.co.deoxybyte-utilities:uint32

Initform

0

Readers

gz-member-mtime (function)

Writers

(setf gz-member-mtime) (function)

Slot: xfl
Type

uk.co.deoxybyte-utilities:uint8

Initform

0

Readers

gz-member-xfl (function)

Writers

(setf gz-member-xfl) (function)

Slot: os
Type

uk.co.deoxybyte-utilities:uint8

Initform

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

Readers

gz-member-os (function)

Writers

(setf gz-member-os) (function)

Slot: xlen
Type

uk.co.deoxybyte-utilities:uint16

Initform

0

Readers

gz-member-xlen (function)

Writers

(setf gz-member-xlen) (function)

Slot: isize
Type

uk.co.deoxybyte-utilities:uint32

Initform

0

Readers

gz-member-isize (function)

Writers

(setf gz-member-isize) (function)

Slot: crc32
Type

uk.co.deoxybyte-utilities:uint32

Initform

0

Readers

gz-member-crc32 (function)

Writers

(setf gz-member-crc32) (function)

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 (function)

Writers

(setf gz-member-cdata) (function)

Slot: cend
Type

uk.co.deoxybyte-utilities:uint32

Initform

0

Readers

gz-member-cend (function)

Writers

(setf gz-member-cend) (function)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.7 Classes

Class: gzip-input-stream ()

A stream that reads bytes from a compressed stream.

Package

uk.co.deoxybyte-gzip

Source

gzip-stream.lisp (file)

Direct superclasses
  • fundamental-binary-input-stream (class)
  • gzip-stream (class)
Direct methods
  • stream-read-sequence (method)
  • stream-read-byte (method)
  • stream-clear-input (method)
Class: gzip-line-input-stream ()
Package

uk.co.deoxybyte-gzip

Source

line-stream.lisp (file)

Direct superclasses
Direct methods
  • more-lines-p (method)
  • stream-read-line (method)
  • stream-read-sequence (method)
  • stream-clear-input (method)
  • stream-delete-file (method)
  • stream-file-position (method)
  • stream-element-type (method)
Direct slots
Slot: buffer

The buffer from which lines are read.

Initargs

:buffer

Initform

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

Slot: eol-code

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

Initargs

:eol-code

Initform

(char-code #\newline)

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 (file)

Direct superclasses
  • fundamental-binary-output-stream (class)
  • gzip-stream (class)
Direct methods
  • stream-write-sequence (method)
  • stream-write-byte (method)
  • stream-force-output (method)
  • stream-finish-output (method)
  • stream-clear-output (method)
Class: gzip-stream ()

A gzip stream capable of reading or writing compressed data.

Package

uk.co.deoxybyte-gzip

Source

gzip-stream.lisp (file)

Direct superclasses

fundamental-stream (class)

Direct subclasses
Direct methods
  • stream-file-position (method)
  • stream-close (method)
  • open-stream-p (method)
  • stream-element-type (method)
Direct slots
Slot: gz

The gzip handle.

Initargs

:gz

Slot: buffer
Initargs

:buffer

Initform

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

Slot: open-stream-p
Initform

t


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Constants

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

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Constant: +octet-buffer-size+
Package

uk.co.deoxybyte-gzip

Source

gzip-stream.lisp (file)

Constant: +z-best-compression+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-best-speed+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-no-compression+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Constant: +z-sync-flush+
Package

zlib-ffi

Source

zlib-ffi.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: %line-stream-read-sequence STREAM SEQUENCE START END
Package

uk.co.deoxybyte-gzip

Source

line-stream.lisp (file)

Function: %line-stream-write-sequence STREAM SEQUENCE START END
Package

uk.co.deoxybyte-gzip

Source

line-stream.lisp (file)

Function: %stream-read-sequence STREAM SEQ &optional START END
Package

uk.co.deoxybyte-gzip

Source

gzip-stream.lisp (file)

Function: %stream-write-sequence STREAM SEQ &optional START END
Package

uk.co.deoxybyte-gzip

Source

gzip-stream.lisp (file)

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

zlib-ffi

Source

zlib-ffi.lisp (file)

Function: copy-gz INSTANCE
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: copy-gz-member INSTANCE
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: empty-to-stream BUFFER STREAM N
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: fill-from-stream BUFFER STREAM N
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

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 (file)

Function: gz-error-message GZ

Returns a zlib error message string relevant to GZ.

Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: gz-flush GZ FLUSH-MODE
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: gz-member-p OBJECT
Package

uk.co.deoxybyte-gzip

Source

rfc1952.lisp (file)

Function: gz-open-p INSTANCE
Function: (setf gz-open-p) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: gz-p OBJECT
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: gz-ptr INSTANCE
Function: (setf gz-ptr) VALUE INSTANCE
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: gz-seek GZ OFFSET
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: gz-tell GZ
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

Function: make-gz &key (PTR PTR) (OPEN-P OPEN-P)
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: z-vector-operation OPERATION SOURCE DEST BACKOFF &rest Z-STREAM-ARGS
Package

uk.co.deoxybyte-gzip

Source

deoxybyte-gzip.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Generic functions

Generic Function: errno-of CONDITION
Package

uk.co.deoxybyte-gzip

Methods
Method: errno-of (CONDITION zlib-error)
Source

conditions.lisp (file)

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 (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Classes

Class: z-stream-tclass ()
Package

zlib-ffi

Source

zlib-ffi.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Types

Type: octet-buffer ()
Package

uk.co.deoxybyte-gzip

Source

gzip-stream.lisp (file)

Type: octet-buffer-index ()
Package

uk.co.deoxybyte-gzip

Source

gzip-stream.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   D   F   L   M  
Index Entry  Section

D
deoxybyte-gzip.asd: The deoxybyte-gzip․asd file
deoxybyte-gzip/deoxybyte-gzip: The deoxybyte-gzip/deoxybyte-gzip module
deoxybyte-gzip/deoxybyte-gzip/conditions.lisp: The deoxybyte-gzip/deoxybyte-gzip/conditions․lisp file
deoxybyte-gzip/deoxybyte-gzip/deoxybyte-gzip.lisp: The deoxybyte-gzip/deoxybyte-gzip/deoxybyte-gzip․lisp file
deoxybyte-gzip/deoxybyte-gzip/gzip-stream.lisp: The deoxybyte-gzip/deoxybyte-gzip/gzip-stream․lisp file
deoxybyte-gzip/deoxybyte-gzip/line-stream.lisp: The deoxybyte-gzip/deoxybyte-gzip/line-stream․lisp file
deoxybyte-gzip/deoxybyte-gzip/package.lisp: The deoxybyte-gzip/deoxybyte-gzip/package․lisp file
deoxybyte-gzip/deoxybyte-gzip/rfc1952.lisp: The deoxybyte-gzip/deoxybyte-gzip/rfc1952․lisp file
deoxybyte-gzip/deoxybyte-gzip/sbcl.lisp: The deoxybyte-gzip/deoxybyte-gzip/sbcl․lisp file
deoxybyte-gzip/deoxybyte-gzip/zlib-ffi.lisp: The deoxybyte-gzip/deoxybyte-gzip/zlib-ffi․lisp file

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

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

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

Jump to:   D   F   L   M  

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

A.2 Functions

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

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

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

A
adler32: Exported functions

C
compress: Exported functions
copy-gz: Internal functions
copy-gz-member: Internal functions
crc32: Exported functions

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

E
empty-to-stream: Internal functions
errno-of: Internal generic functions
errno-of: Internal generic functions

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

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

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

M
Macro, deflate-init: Exported macros
Macro, deflate-init2: Exported macros
Macro, inflate-init: Exported macros
Macro, inflate-init2: Exported macros
Macro, with-gz-file: Exported macros
Macro, with-open-gzip: Exported macros
make-gz: Internal functions
make-gz-member: Exported functions
make-z-stream: Internal functions
Method, errno-of: Internal generic functions
Method, stream-delete-file: Internal generic functions

R
read-octet-line: Internal functions

S
stream-delete-file: Internal generic functions
stream-delete-file: Internal generic functions

U
uncompress: Exported functions

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

Z
z-error: Internal functions
z-stream-close: Internal functions
z-stream-open: Internal functions
z-stream-operation: Internal functions
z-vector-operation: Internal functions
zlib-version: Exported functions

Jump to:   %   (  
A   C   D   E   F   G   I   M   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*: Exported symbol macros

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

B
buffer: Exported classes
buffer: Exported classes

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

E
eol-code: Exported classes
errno: Exported conditions

F
filespec: Exported classes
flg: Exported structures

G
gz: Exported classes
gz: Exported classes

I
id1: Exported structures
id2: Exported structures
isize: Exported structures

M
mtime: Exported structures

N
num-bytes: Exported classes

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

P
ptr: Exported structures

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

X
xfl: Exported structures
xlen: Exported 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   G   O   P   S   T   U   Z  
Index Entry  Section

C
Class, gzip-input-stream: Exported classes
Class, gzip-line-input-stream: Exported classes
Class, gzip-output-stream: Exported classes
Class, gzip-stream: Exported classes
Class, z-stream-tclass: Internal classes
Condition, gz-io-error: Exported conditions
Condition, zlib-error: Exported conditions

D
deoxybyte-gzip: The deoxybyte-gzip system

G
gz: Exported structures
gz-io-error: Exported conditions
gz-member: Exported structures
gzip-input-stream: Exported classes
gzip-line-input-stream: Exported classes
gzip-output-stream: Exported classes
gzip-stream: Exported classes

O
octet-buffer: Internal types
octet-buffer-index: Internal types

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

S
Structure, gz: Exported structures
Structure, gz-member: Exported structures
System, deoxybyte-gzip: The deoxybyte-gzip system

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

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

Z
z-stream-tclass: Internal classes
zlib-error: Exported conditions
zlib-ffi: The zlib-ffi package

Jump to:   C   D   G   O   P   S   T   U   Z