The gzip-stream Reference Manual

This is the gzip-stream Reference Manual, version 0.2.8, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:56:55 2022 GMT+0.

1 Systems

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

gzip-stream

1.1 `gzip-stream`

Version

0.2.8

Dependencies

salza2 (system).
flexi-streams (system).
trivial-gray-streams (system).

Source

gzip-stream.asd.

Child Components

package.lisp (file).
ifstar.lisp (file).
inflate.lisp (file).
gzip-stream.lisp (file).
gzip.lisp (file).

2 Files

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

Lisp

2.1.1 `gzip-stream/gzip-stream.asd`

Source: gzip-stream.asd.
Parent Component: gzip-stream (system).
ASDF Systems: gzip-stream.
Packages: gzip-system.

2.1.2 `gzip-stream/package.lisp`

Source: gzip-stream.asd.
Parent Component: gzip-stream (system).
Packages: gzip-stream.

2.1.3 `gzip-stream/ifstar.lisp`

Dependency

package.lisp (file).

Source

gzip-stream.asd.

Parent Component

gzip-stream (system).

Internals

if* (macro).
if*-keyword-list (special variable).

2.1.4 `gzip-stream/inflate.lisp`

Dependency

ifstar.lisp (file).

Source

gzip-stream.asd.

Parent Component

gzip-stream (system).

Internals

*base-distance* (special variable).
*base-length* (special variable).
*code-index* (special variable).
*distance-extra-bits* (special variable).
*fixed-huffman-distance-tree* (special variable).
*fixed-huffman-tree* (special variable).
*length-extra-bits* (special variable).
*maskarray* (special variable).
bit-reader (structure).
bit-reader-bits (reader).
(setf bit-reader-bits) (writer).
bit-reader-last-byte (reader).
(setf bit-reader-last-byte) (writer).
bit-reader-p (function).
bit-reader-stream (reader).
(setf bit-reader-stream) (writer).
bitinfo-bitwidth (function).
(setf bitinfo-bitwidth) (function).
bitinfo-maxval (function).
(setf bitinfo-maxval) (function).
bitinfo-minval (function).
(setf bitinfo-minval) (function).
build-huffman-tree (function).
copy-bit-reader (function).
decode-huffman-tree (function).
flush-buffer (function).
generate-huffman-tree (function).
generate-huffman-tree-from-vector (function).
gz_ascii_flags (constant).
gz_comment (constant).
gz_extra_field (constant).
gz_head_crc (constant).
gz_orig_name (constant).
gz_reserved (constant).
inflate (function).
make-bit-reader (function).
make-bitinfo (function).
new-bit-reader (function).
process-deflate-block (function).
process-dynamic-huffman-block (function).
process-fixed-huffman-block (function).
process-huffman-block (function).
process-non-compressed-block (function).
put-byte-in-buffer (function).
read-bits (function).
read-uword (function).
reset-bit-reader (function).
skip-gzip-header (function).
split-on-position (function).
z_deflated (constant).

2.1.5 `gzip-stream/gzip-stream.lisp`

Dependency

inflate.lisp (file).

Source

gzip-stream.asd.

Parent Component

gzip-stream (system).

Public Interface

close (method).
close (method).
gunzip (function).
gzip (function).
gzip-input-stream (class).
gzip-output-stream (class).
initialize-instance (method).
initialize-instance (method).
make-gzip-input-stream (function).
make-gzip-output-stream (function).
stream-clear-input (method).
stream-clear-output (method).
stream-element-type (method).
stream-element-type (method).
stream-finish-output (method).
stream-force-output (method).
stream-line-column (method).
stream-listen (method).
stream-read-byte (method).
stream-read-char (method).
stream-read-line (method).
stream-read-sequence (method).
stream-write-byte (method).
stream-write-char (method).
stream-write-sequence (method).
stream-write-string (method).
with-open-gzip-file (macro).

Internals

+buffer-size+ (constant).
bit-reader-of (reader method).
(setf bit-reader-of) (writer method).
compress-buffer (reader method).
(setf compress-buffer) (writer method).
data-buffer-of (reader method).
(setf data-buffer-of) (writer method).
deflate-stream (reader method).
(setf deflate-stream) (writer method).
fill-buffer (function).
input-pos (reader method).
(setf input-pos) (writer method).
make-buffer (function).
read-buffer-of (reader method).
(setf read-buffer-of) (writer method).
under-file (reader method).
(setf under-file) (writer method).
underfile-of (reader method).
(setf underfile-of) (writer method).

2.1.6 `gzip-stream/gzip.lisp`

Dependency

gzip-stream.lisp (file).

Source

gzip-stream.asd.

Parent Component

gzip-stream (system).

Public Interface

gunzip-sequence (method).
gunzip-sequence (method).
gzip-sequence (method).
gzip-sequence (method).

Internals

gunzip-byte-array (function).
gunzip-string (function).
gzip-byte-array (function).
gzip-string (function).

3 Packages

Packages are listed by definition order.

gzip-system
gzip-stream

3.1 `gzip-system`

Source

gzip-stream.asd.

Use List

asdf/interface.
common-lisp.

3.2 `gzip-stream`

Source

package.lisp.

Use List

common-lisp.
flexi-streams.
trivial-gray-streams.

Public Interface

gunzip (function).
gunzip-sequence (generic function).
gzip (function).
gzip-input-stream (class).
gzip-output-stream (class).
gzip-sequence (generic function).
make-gzip-input-stream (function).
make-gzip-output-stream (function).
with-open-gzip-file (macro).

Internals

*base-distance* (special variable).
*base-length* (special variable).
*code-index* (special variable).
*distance-extra-bits* (special variable).
*fixed-huffman-distance-tree* (special variable).
*fixed-huffman-tree* (special variable).
*length-extra-bits* (special variable).
*maskarray* (special variable).
+buffer-size+ (constant).
bit-reader (structure).
bit-reader-bits (reader).
(setf bit-reader-bits) (writer).
bit-reader-last-byte (reader).
(setf bit-reader-last-byte) (writer).
bit-reader-of (generic reader).
(setf bit-reader-of) (generic writer).
bit-reader-p (function).
bit-reader-stream (reader).
(setf bit-reader-stream) (writer).
bitinfo-bitwidth (function).
(setf bitinfo-bitwidth) (function).
bitinfo-maxval (function).
(setf bitinfo-maxval) (function).
bitinfo-minval (function).
(setf bitinfo-minval) (function).
build-huffman-tree (function).
compress-buffer (generic reader).
(setf compress-buffer) (generic writer).
copy-bit-reader (function).
copy-bitinfo (function).
data-buffer-of (generic reader).
(setf data-buffer-of) (generic writer).
decode-huffman-tree (function).
deflate-stream (generic reader).
(setf deflate-stream) (generic writer).
fill-buffer (function).
flush-buffer (function).
generate-huffman-tree (function).
generate-huffman-tree-from-vector (function).
gunzip-byte-array (function).
gunzip-string (function).
gz_ascii_flags (constant).
gz_comment (constant).
gz_extra_field (constant).
gz_head_crc (constant).
gz_orig_name (constant).
gz_reserved (constant).
gzip-byte-array (function).
gzip-string (function).
if* (macro).
if*-keyword-list (special variable).
inflate (function).
input-pos (generic reader).
(setf input-pos) (generic writer).
make-bit-reader (function).
make-bitinfo (function).
make-buffer (function).
new-bit-reader (function).
process-deflate-block (function).
process-dynamic-huffman-block (function).
process-fixed-huffman-block (function).
process-huffman-block (function).
process-non-compressed-block (function).
put-byte-in-buffer (function).
read-bits (function).
read-buffer-of (generic reader).
(setf read-buffer-of) (generic writer).
read-uword (function).
reset-bit-reader (function).
skip-gzip-header (function).
split-on-position (function).
under-file (generic reader).
(setf under-file) (generic writer).
underfile-of (generic reader).
(setf underfile-of) (generic writer).
z_deflated (constant).

4 Definitions

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

Public Interface
Internals

4.1 Public Interface

Macros
Ordinary functions
Generic functions
Standalone methods
Classes

4.1.1 Macros

Macro: with-open-gzip-file ((var path &rest open-args &key direction &allow-other-keys) &body body) ¶

Package: gzip-stream.
Source: gzip-stream.lisp.

4.1.2 Ordinary functions

Function: gunzip (in-file out-file) ¶

Extracts the contents of GZIP file IN-FILE and writes the output to OUT-FILE.

Package: gzip-stream.
Source: gzip-stream.lisp.

Function: gzip (in-file out-file) ¶

GZIPS the contents of in-file and writes the output to outfile.

Package: gzip-stream.
Source: gzip-stream.lisp.

Function: make-gzip-input-stream (stream) ¶

Package: gzip-stream.
Source: gzip-stream.lisp.

Function: make-gzip-output-stream (stream) ¶

Package: gzip-stream.
Source: gzip-stream.lisp.

4.1.3 Generic functions

Generic Function: gunzip-sequence (sequence) ¶

Package

gzip-stream.

Methods

Method: gunzip-sequence ((sequence vector)) ¶

Source: gzip.lisp.

Method: gunzip-sequence ((sequence string)) ¶

Source: gzip.lisp.

Generic Function: gzip-sequence (sequence) ¶

Package

gzip-stream.

Methods

Method: gzip-sequence ((sequence vector)) ¶

Source: gzip.lisp.

Method: gzip-sequence ((sequence string)) ¶

Source: gzip.lisp.

4.1.4 Standalone methods

Method: close ((stream gzip-output-stream) &key abort) ¶

Source: gzip-stream.lisp.

Method: close ((stream gzip-input-stream) &key abort) ¶

Source: gzip-stream.lisp.

Method: initialize-instance :after ((stream gzip-output-stream) &rest initargs &key) ¶

Source: gzip-stream.lisp.

Method: initialize-instance :after ((obj gzip-input-stream) &rest args) ¶

Source: gzip-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-element-type ((stream gzip-output-stream)) ¶

Source: gzip-stream.lisp.

Method: stream-element-type ((stream gzip-input-stream)) ¶

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-line-column ((stream gzip-output-stream)) ¶

Package: sb-gray.
Source: gzip-stream.lisp.

Method: stream-listen ((stream gzip-input-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-char ((stream gzip-input-stream)) ¶

Reads the next character from the given STREAM. Returns :eof when end of file is reached.

Package: sb-gray.
Source: gzip-stream.lisp.

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

Reads the next line from the given gzip-input stream. The #Newline is used as a line separator.

Returns (STR . EOF-P). EOF-P is T when of end of file is reached.

Package: sb-gray.
Source: gzip-stream.lisp.

Method: stream-read-sequence ((stream gzip-input-stream) sequence start end &key) ¶

Package: trivial-gray-streams.
Source: gzip-stream.lisp.

Method: stream-write-byte ((stream gzip-output-stream) byte) ¶

Package: sb-gray.
Source: gzip-stream.lisp.

Method: stream-write-char ((stream gzip-output-stream) char) ¶

Package: sb-gray.
Source: gzip-stream.lisp.

Method: stream-write-sequence ((stream gzip-output-stream) sequence start end &key) ¶

Package: trivial-gray-streams.
Source: gzip-stream.lisp.

Method: stream-write-string ((stream gzip-output-stream) string &optional start end) ¶

Package: sb-gray.
Source: gzip-stream.lisp.

4.1.5 Classes

Class: gzip-input-stream ¶

Package

gzip-stream.

Source

gzip-stream.lisp.

Direct superclasses

fundamental-binary-input-stream.
trivial-gray-stream-mixin.

Direct methods

(setf bit-reader-of).
bit-reader-of.
close.
(setf data-buffer-of).
data-buffer-of.
initialize-instance.
(setf read-buffer-of).
read-buffer-of.
stream-clear-input.
stream-element-type.
stream-listen.
stream-read-byte.
stream-read-char.
stream-read-line.
stream-read-sequence.
(setf underfile-of).
underfile-of.

Direct slots

Slot: underfile ¶

Initargs: :understream
Readers: underfile-of.
Writers: (setf underfile-of).

Slot: read-buffer ¶

Initform: (flexi-streams:make-in-memory-input-stream "")
Readers: read-buffer-of.
Writers: (setf read-buffer-of).

Slot: data-buffer ¶

Initform: (gzip-stream::make-buffer)
Readers: data-buffer-of.
Writers: (setf data-buffer-of).

Slot: bit-reader ¶

Readers: bit-reader-of.
Writers: (setf bit-reader-of).

Slot: last-end ¶

Initform: 0

Class: gzip-output-stream ¶

Package

gzip-stream.

Source

gzip-stream.lisp.

Direct superclasses

fundamental-binary-output-stream.
trivial-gray-stream-mixin.

Direct methods

close.
(setf compress-buffer).
compress-buffer.
(setf deflate-stream).
deflate-stream.
initialize-instance.
(setf input-pos).
input-pos.
stream-clear-output.
stream-element-type.
stream-finish-output.
stream-force-output.
stream-line-column.
stream-write-byte.
stream-write-char.
stream-write-sequence.
stream-write-string.
(setf under-file).
under-file.

Direct slots

Slot: underlying-file ¶

Initargs: :understream
Readers: under-file.
Writers: (setf under-file).

Slot: input-buffer ¶

Initform: (gzip-stream::make-buffer)

Slot: input-pos ¶

Type: fixnum
Initform: 0
Readers: input-pos.
Writers: (setf input-pos).

Slot: deflate-stream ¶

Readers: deflate-stream.
Writers: (setf deflate-stream).

Slot: size ¶

Type: fixnum
Initform: 0

Slot: crc-high ¶

Initform: 65535

Slot: crc-low ¶

Initform: 65535

Slot: compress-buffer ¶

Initargs: :buffer
Readers: compress-buffer.
Writers: (setf compress-buffer).

4.2 Internals

Constants
Special variables
Macros
Ordinary functions
Generic functions
Structures

4.2.1 Constants

Constant: +buffer-size+ ¶

Package: gzip-stream.
Source: gzip-stream.lisp.

Constant: gz_ascii_flags ¶

Package: gzip-stream.
Source: inflate.lisp.

Constant: gz_comment ¶

Package: gzip-stream.
Source: inflate.lisp.

Constant: gz_extra_field ¶

Package: gzip-stream.
Source: inflate.lisp.

Constant: gz_head_crc ¶

Package: gzip-stream.
Source: inflate.lisp.

Constant: gz_orig_name ¶

Package: gzip-stream.
Source: inflate.lisp.

Constant: gz_reserved ¶

Package: gzip-stream.
Source: inflate.lisp.

Constant: z_deflated ¶

Package: gzip-stream.
Source: inflate.lisp.

4.2.2 Special variables

Special Variable: *base-distance* ¶

Package: gzip-stream.
Source: inflate.lisp.

Special Variable: *base-length* ¶

Package: gzip-stream.
Source: inflate.lisp.

Special Variable: *code-index* ¶

Package: gzip-stream.
Source: inflate.lisp.

Special Variable: *distance-extra-bits* ¶

Package: gzip-stream.
Source: inflate.lisp.

Special Variable: *fixed-huffman-distance-tree* ¶

Package: gzip-stream.
Source: inflate.lisp.

Special Variable: *fixed-huffman-tree* ¶

Package: gzip-stream.
Source: inflate.lisp.

Special Variable: *length-extra-bits* ¶

Package: gzip-stream.
Source: inflate.lisp.

Special Variable: *maskarray* ¶

Package: gzip-stream.
Source: inflate.lisp.

Special Variable: if*-keyword-list ¶

Package: gzip-stream.
Source: ifstar.lisp.

4.2.3 Macros

Macro: if* (&rest args) ¶

Package: gzip-stream.
Source: ifstar.lisp.

4.2.4 Ordinary functions

Reader: bit-reader-bits (instance) ¶

Writer: (setf bit-reader-bits) (instance) ¶

Package: gzip-stream.
Source: inflate.lisp.
Target Slot: bits.

Reader: bit-reader-last-byte (instance) ¶

Writer: (setf bit-reader-last-byte) (instance) ¶

Package: gzip-stream.
Source: inflate.lisp.
Target Slot: last-byte.

Function: bit-reader-p (object) ¶

Package: gzip-stream.
Source: inflate.lisp.

Reader: bit-reader-stream (instance) ¶

Writer: (setf bit-reader-stream) (instance) ¶

Package: gzip-stream.
Source: inflate.lisp.
Target Slot: stream.

Function: bitinfo-bitwidth (structure) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: (setf bitinfo-bitwidth) (structure) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: bitinfo-maxval (structure) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: (setf bitinfo-maxval) (structure) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: bitinfo-minval (structure) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: (setf bitinfo-minval) (structure) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: build-huffman-tree (minval minmaxes valuecode valuewidth pos) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: copy-bit-reader (instance) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: copy-bitinfo (sequence) ¶

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package: gzip-stream.
Alias for: copy-seq.

Function: decode-huffman-tree (br tree minbits) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: fill-buffer (stream) ¶

Package: gzip-stream.
Source: gzip-stream.lisp.

Function: flush-buffer (op buffer end) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: generate-huffman-tree (bitinfo) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: generate-huffman-tree-from-vector (vector start end) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: gunzip-byte-array (sequence) ¶

Package: gzip-stream.
Source: gzip.lisp.

Function: gunzip-string (string) ¶

Package: gzip-stream.
Source: gzip.lisp.

Function: gzip-byte-array (sequence) ¶

Package: gzip-stream.
Source: gzip.lisp.

Function: gzip-string (sequence) ¶

Package: gzip-stream.
Source: gzip.lisp.

Function: inflate (p op) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: make-bit-reader (&key stream last-byte bits) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: make-bitinfo (&key minval maxval bitwidth) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: make-buffer () ¶

Package: gzip-stream.
Source: gzip-stream.lisp.

Function: new-bit-reader (stream) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: process-deflate-block (br op buffer end) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: process-dynamic-huffman-block (br op buffer end) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: process-fixed-huffman-block (br op buffer end) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: process-huffman-block (br op lengthlit-tree minwidth distance-tree mindistwidth buffer end) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: process-non-compressed-block (br op buffer end) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: put-byte-in-buffer (op byte buffer end) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: read-bits (br count) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: read-uword (stream) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: reset-bit-reader (br) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: skip-gzip-header (p) ¶

Package: gzip-stream.
Source: inflate.lisp.

Function: split-on-position (minval minmaxes valuecode valuewidth pos) ¶

Package: gzip-stream.
Source: inflate.lisp.

4.2.5 Generic functions

Generic Reader: bit-reader-of (object) ¶

Package

gzip-stream.

Methods

Reader Method: bit-reader-of ((gzip-input-stream gzip-input-stream)) ¶

automatically generated reader method

Source: gzip-stream.lisp.
Target Slot: bit-reader.

Generic Writer: (setf bit-reader-of) (object) ¶

Package

gzip-stream.

Methods

Writer Method: (setf bit-reader-of) ((gzip-input-stream gzip-input-stream)) ¶

automatically generated writer method

Source: gzip-stream.lisp.
Target Slot: bit-reader.

Generic Reader: compress-buffer (object) ¶

Package

gzip-stream.

Methods

Reader Method: compress-buffer ((gzip-output-stream gzip-output-stream)) ¶

automatically generated reader method

Source: gzip-stream.lisp.
Target Slot: compress-buffer.

Generic Writer: (setf compress-buffer) (object) ¶

Package

gzip-stream.

Methods

Writer Method: (setf compress-buffer) ((gzip-output-stream gzip-output-stream)) ¶

automatically generated writer method

Source: gzip-stream.lisp.
Target Slot: compress-buffer.

Generic Reader: data-buffer-of (object) ¶

Package

gzip-stream.

Methods

Reader Method: data-buffer-of ((gzip-input-stream gzip-input-stream)) ¶

automatically generated reader method

Source: gzip-stream.lisp.
Target Slot: data-buffer.

Generic Writer: (setf data-buffer-of) (object) ¶

Package

gzip-stream.

Methods

Writer Method: (setf data-buffer-of) ((gzip-input-stream gzip-input-stream)) ¶

automatically generated writer method

Source: gzip-stream.lisp.
Target Slot: data-buffer.

Generic Reader: deflate-stream (object) ¶

Package

gzip-stream.

Methods

Reader Method: deflate-stream ((gzip-output-stream gzip-output-stream)) ¶

automatically generated reader method

Source: gzip-stream.lisp.
Target Slot: deflate-stream.

Generic Writer: (setf deflate-stream) (object) ¶

Package

gzip-stream.

Methods

Writer Method: (setf deflate-stream) ((gzip-output-stream gzip-output-stream)) ¶

automatically generated writer method

Source: gzip-stream.lisp.
Target Slot: deflate-stream.

Generic Reader: input-pos (object) ¶

Package

gzip-stream.

Methods

Reader Method: input-pos ((gzip-output-stream gzip-output-stream)) ¶

automatically generated reader method

Source: gzip-stream.lisp.
Target Slot: input-pos.

Generic Writer: (setf input-pos) (object) ¶

Package

gzip-stream.

Methods

Writer Method: (setf input-pos) ((gzip-output-stream gzip-output-stream)) ¶

automatically generated writer method

Source: gzip-stream.lisp.
Target Slot: input-pos.

Generic Reader: read-buffer-of (object) ¶

Package

gzip-stream.

Methods

Reader Method: read-buffer-of ((gzip-input-stream gzip-input-stream)) ¶

automatically generated reader method

Source: gzip-stream.lisp.
Target Slot: read-buffer.

Generic Writer: (setf read-buffer-of) (object) ¶

Package

gzip-stream.

Methods

Writer Method: (setf read-buffer-of) ((gzip-input-stream gzip-input-stream)) ¶

automatically generated writer method

Source: gzip-stream.lisp.
Target Slot: read-buffer.

Generic Reader: under-file (object) ¶

Package

gzip-stream.

Methods

Reader Method: under-file ((gzip-output-stream gzip-output-stream)) ¶

automatically generated reader method

Source: gzip-stream.lisp.
Target Slot: underlying-file.

Generic Writer: (setf under-file) (object) ¶

Package

gzip-stream.

Methods

Writer Method: (setf under-file) ((gzip-output-stream gzip-output-stream)) ¶

automatically generated writer method

Source: gzip-stream.lisp.
Target Slot: underlying-file.

Generic Reader: underfile-of (object) ¶

Package

gzip-stream.

Methods

Reader Method: underfile-of ((gzip-input-stream gzip-input-stream)) ¶

automatically generated reader method

Source: gzip-stream.lisp.
Target Slot: underfile.

Generic Writer: (setf underfile-of) (object) ¶

Package

gzip-stream.

Methods

Writer Method: (setf underfile-of) ((gzip-input-stream gzip-input-stream)) ¶

automatically generated writer method

Source: gzip-stream.lisp.
Target Slot: underfile.

4.2.6 Structures

Structure: bit-reader ¶

Package

gzip-stream.

Source

inflate.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: stream ¶

Package: common-lisp.
Readers: bit-reader-stream.
Writers: (setf bit-reader-stream).

Slot: last-byte ¶

Readers: bit-reader-last-byte.
Writers: (setf bit-reader-last-byte).

Slot: bits ¶

Readers: bit-reader-bits.
Writers: (setf bit-reader-bits).

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	( B C D F G I M N P R S U W

	Index Entry	Section

(
	`(setf bit-reader-bits)`:	Private ordinary functions
	`(setf bit-reader-last-byte)`:	Private ordinary functions
	`(setf bit-reader-of)`:	Private generic functions
	`(setf bit-reader-of)`:	Private generic functions
	`(setf bit-reader-stream)`:	Private ordinary functions
	`(setf bitinfo-bitwidth)`:	Private ordinary functions
	`(setf bitinfo-maxval)`:	Private ordinary functions
	`(setf bitinfo-minval)`:	Private ordinary functions
	`(setf compress-buffer)`:	Private generic functions
	`(setf compress-buffer)`:	Private generic functions
	`(setf data-buffer-of)`:	Private generic functions
	`(setf data-buffer-of)`:	Private generic functions
	`(setf deflate-stream)`:	Private generic functions
	`(setf deflate-stream)`:	Private generic functions
	`(setf input-pos)`:	Private generic functions
	`(setf input-pos)`:	Private generic functions
	`(setf read-buffer-of)`:	Private generic functions
	`(setf read-buffer-of)`:	Private generic functions
	`(setf under-file)`:	Private generic functions
	`(setf under-file)`:	Private generic functions
	`(setf underfile-of)`:	Private generic functions
	`(setf underfile-of)`:	Private generic functions

B
	`bit-reader-bits`:	Private ordinary functions
	`bit-reader-last-byte`:	Private ordinary functions
	`bit-reader-of`:	Private generic functions
	`bit-reader-of`:	Private generic functions
	`bit-reader-p`:	Private ordinary functions
	`bit-reader-stream`:	Private ordinary functions
	`bitinfo-bitwidth`:	Private ordinary functions
	`bitinfo-maxval`:	Private ordinary functions
	`bitinfo-minval`:	Private ordinary functions
	`build-huffman-tree`:	Private ordinary functions

C
	`close`:	Public standalone methods
	`close`:	Public standalone methods
	`compress-buffer`:	Private generic functions
	`compress-buffer`:	Private generic functions
	`copy-bit-reader`:	Private ordinary functions
	`copy-bitinfo`:	Private ordinary functions

D
	`data-buffer-of`:	Private generic functions
	`data-buffer-of`:	Private generic functions
	`decode-huffman-tree`:	Private ordinary functions
	`deflate-stream`:	Private generic functions
	`deflate-stream`:	Private generic functions

F
	`fill-buffer`:	Private ordinary functions
	`flush-buffer`:	Private ordinary functions
	`Function, (setf bit-reader-bits)`:	Private ordinary functions
	`Function, (setf bit-reader-last-byte)`:	Private ordinary functions
	`Function, (setf bit-reader-stream)`:	Private ordinary functions
	`Function, (setf bitinfo-bitwidth)`:	Private ordinary functions
	`Function, (setf bitinfo-maxval)`:	Private ordinary functions
	`Function, (setf bitinfo-minval)`:	Private ordinary functions
	`Function, bit-reader-bits`:	Private ordinary functions
	`Function, bit-reader-last-byte`:	Private ordinary functions
	`Function, bit-reader-p`:	Private ordinary functions
	`Function, bit-reader-stream`:	Private ordinary functions
	`Function, bitinfo-bitwidth`:	Private ordinary functions
	`Function, bitinfo-maxval`:	Private ordinary functions
	`Function, bitinfo-minval`:	Private ordinary functions
	`Function, build-huffman-tree`:	Private ordinary functions
	`Function, copy-bit-reader`:	Private ordinary functions
	`Function, copy-bitinfo`:	Private ordinary functions
	`Function, decode-huffman-tree`:	Private ordinary functions
	`Function, fill-buffer`:	Private ordinary functions
	`Function, flush-buffer`:	Private ordinary functions
	`Function, generate-huffman-tree`:	Private ordinary functions
	`Function, generate-huffman-tree-from-vector`:	Private ordinary functions
	`Function, gunzip`:	Public ordinary functions
	`Function, gunzip-byte-array`:	Private ordinary functions
	`Function, gunzip-string`:	Private ordinary functions
	`Function, gzip`:	Public ordinary functions
	`Function, gzip-byte-array`:	Private ordinary functions
	`Function, gzip-string`:	Private ordinary functions
	`Function, inflate`:	Private ordinary functions
	`Function, make-bit-reader`:	Private ordinary functions
	`Function, make-bitinfo`:	Private ordinary functions
	`Function, make-buffer`:	Private ordinary functions
	`Function, make-gzip-input-stream`:	Public ordinary functions
	`Function, make-gzip-output-stream`:	Public ordinary functions
	`Function, new-bit-reader`:	Private ordinary functions
	`Function, process-deflate-block`:	Private ordinary functions
	`Function, process-dynamic-huffman-block`:	Private ordinary functions
	`Function, process-fixed-huffman-block`:	Private ordinary functions
	`Function, process-huffman-block`:	Private ordinary functions
	`Function, process-non-compressed-block`:	Private ordinary functions
	`Function, put-byte-in-buffer`:	Private ordinary functions
	`Function, read-bits`:	Private ordinary functions
	`Function, read-uword`:	Private ordinary functions
	`Function, reset-bit-reader`:	Private ordinary functions
	`Function, skip-gzip-header`:	Private ordinary functions
	`Function, split-on-position`:	Private ordinary functions

G
	`generate-huffman-tree`:	Private ordinary functions
	`generate-huffman-tree-from-vector`:	Private ordinary functions
	`Generic Function, (setf bit-reader-of)`:	Private generic functions
	`Generic Function, (setf compress-buffer)`:	Private generic functions
	`Generic Function, (setf data-buffer-of)`:	Private generic functions
	`Generic Function, (setf deflate-stream)`:	Private generic functions
	`Generic Function, (setf input-pos)`:	Private generic functions
	`Generic Function, (setf read-buffer-of)`:	Private generic functions
	`Generic Function, (setf under-file)`:	Private generic functions
	`Generic Function, (setf underfile-of)`:	Private generic functions
	`Generic Function, bit-reader-of`:	Private generic functions
	`Generic Function, compress-buffer`:	Private generic functions
	`Generic Function, data-buffer-of`:	Private generic functions
	`Generic Function, deflate-stream`:	Private generic functions
	`Generic Function, gunzip-sequence`:	Public generic functions
	`Generic Function, gzip-sequence`:	Public generic functions
	`Generic Function, input-pos`:	Private generic functions
	`Generic Function, read-buffer-of`:	Private generic functions
	`Generic Function, under-file`:	Private generic functions
	`Generic Function, underfile-of`:	Private generic functions
	`gunzip`:	Public ordinary functions
	`gunzip-byte-array`:	Private ordinary functions
	`gunzip-sequence`:	Public generic functions
	`gunzip-sequence`:	Public generic functions
	`gunzip-sequence`:	Public generic functions
	`gunzip-string`:	Private ordinary functions
	`gzip`:	Public ordinary functions
	`gzip-byte-array`:	Private ordinary functions
	`gzip-sequence`:	Public generic functions
	`gzip-sequence`:	Public generic functions
	`gzip-sequence`:	Public generic functions
	`gzip-string`:	Private ordinary functions

I
	`if*`:	Private macros
	`inflate`:	Private ordinary functions
	`initialize-instance`:	Public standalone methods
	`initialize-instance`:	Public standalone methods
	`input-pos`:	Private generic functions
	`input-pos`:	Private generic functions

M
	`Macro, if*`:	Private macros
	`Macro, with-open-gzip-file`:	Public macros
	`make-bit-reader`:	Private ordinary functions
	`make-bitinfo`:	Private ordinary functions
	`make-buffer`:	Private ordinary functions
	`make-gzip-input-stream`:	Public ordinary functions
	`make-gzip-output-stream`:	Public ordinary functions
	`Method, (setf bit-reader-of)`:	Private generic functions
	`Method, (setf compress-buffer)`:	Private generic functions
	`Method, (setf data-buffer-of)`:	Private generic functions
	`Method, (setf deflate-stream)`:	Private generic functions
	`Method, (setf input-pos)`:	Private generic functions
	`Method, (setf read-buffer-of)`:	Private generic functions
	`Method, (setf under-file)`:	Private generic functions
	`Method, (setf underfile-of)`:	Private generic functions
	`Method, bit-reader-of`:	Private generic functions
	`Method, close`:	Public standalone methods
	`Method, close`:	Public standalone methods
	`Method, compress-buffer`:	Private generic functions
	`Method, data-buffer-of`:	Private generic functions
	`Method, deflate-stream`:	Private generic functions
	`Method, gunzip-sequence`:	Public generic functions
	`Method, gunzip-sequence`:	Public generic functions
	`Method, gzip-sequence`:	Public generic functions
	`Method, gzip-sequence`:	Public generic functions
	`Method, initialize-instance`:	Public standalone methods
	`Method, initialize-instance`:	Public standalone methods
	`Method, input-pos`:	Private generic functions
	`Method, read-buffer-of`:	Private generic functions
	`Method, stream-clear-input`:	Public standalone methods
	`Method, stream-clear-output`:	Public standalone methods
	`Method, stream-element-type`:	Public standalone methods
	`Method, stream-element-type`:	Public standalone methods
	`Method, stream-finish-output`:	Public standalone methods
	`Method, stream-force-output`:	Public standalone methods
	`Method, stream-line-column`:	Public standalone methods
	`Method, stream-listen`:	Public standalone methods
	`Method, stream-read-byte`:	Public standalone methods
	`Method, stream-read-char`:	Public standalone methods
	`Method, stream-read-line`:	Public standalone methods
	`Method, stream-read-sequence`:	Public standalone methods
	`Method, stream-write-byte`:	Public standalone methods
	`Method, stream-write-char`:	Public standalone methods
	`Method, stream-write-sequence`:	Public standalone methods
	`Method, stream-write-string`:	Public standalone methods
	`Method, under-file`:	Private generic functions
	`Method, underfile-of`:	Private generic functions

N
	`new-bit-reader`:	Private ordinary functions

P
	`process-deflate-block`:	Private ordinary functions
	`process-dynamic-huffman-block`:	Private ordinary functions
	`process-fixed-huffman-block`:	Private ordinary functions
	`process-huffman-block`:	Private ordinary functions
	`process-non-compressed-block`:	Private ordinary functions
	`put-byte-in-buffer`:	Private ordinary functions

R
	`read-bits`:	Private ordinary functions
	`read-buffer-of`:	Private generic functions
	`read-buffer-of`:	Private generic functions
	`read-uword`:	Private ordinary functions
	`reset-bit-reader`:	Private ordinary functions

S
	`skip-gzip-header`:	Private ordinary functions
	`split-on-position`:	Private ordinary functions
	`stream-clear-input`:	Public standalone methods
	`stream-clear-output`:	Public standalone methods
	`stream-element-type`:	Public standalone methods
	`stream-element-type`:	Public standalone methods
	`stream-finish-output`:	Public standalone methods
	`stream-force-output`:	Public standalone methods
	`stream-line-column`:	Public standalone methods
	`stream-listen`:	Public standalone methods
	`stream-read-byte`:	Public standalone methods
	`stream-read-char`:	Public standalone methods
	`stream-read-line`:	Public standalone methods
	`stream-read-sequence`:	Public standalone methods
	`stream-write-byte`:	Public standalone methods
	`stream-write-char`:	Public standalone methods
	`stream-write-sequence`:	Public standalone methods
	`stream-write-string`:	Public standalone methods

U
	`under-file`:	Private generic functions
	`under-file`:	Private generic functions
	`underfile-of`:	Private generic functions
	`underfile-of`:	Private generic functions

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

Jump to:	( B C D F G I M N P R S U W

A.3 Variables

Jump to:	* + B C D G I L R S U Z

	Index Entry	Section

*
	`base-distance`:	Private special variables
	`base-length`:	Private special variables
	`code-index`:	Private special variables
	`distance-extra-bits`:	Private special variables
	`fixed-huffman-distance-tree`:	Private special variables
	`fixed-huffman-tree`:	Private special variables
	`length-extra-bits`:	Private special variables
	`maskarray`:	Private special variables

+
	`+buffer-size+`:	Private constants

B
	`bit-reader`:	Public classes
	`bits`:	Private structures

C
	`compress-buffer`:	Public classes
	`Constant, +buffer-size+`:	Private constants
	`Constant, gz_ascii_flags`:	Private constants
	`Constant, gz_comment`:	Private constants
	`Constant, gz_extra_field`:	Private constants
	`Constant, gz_head_crc`:	Private constants
	`Constant, gz_orig_name`:	Private constants
	`Constant, gz_reserved`:	Private constants
	`Constant, z_deflated`:	Private constants
	`crc-high`:	Public classes
	`crc-low`:	Public classes

D
	`data-buffer`:	Public classes
	`deflate-stream`:	Public classes

G
	`gz_ascii_flags`:	Private constants
	`gz_comment`:	Private constants
	`gz_extra_field`:	Private constants
	`gz_head_crc`:	Private constants
	`gz_orig_name`:	Private constants
	`gz_reserved`:	Private constants

I
	`if*-keyword-list`:	Private special variables
	`input-buffer`:	Public classes
	`input-pos`:	Public classes

L
	`last-byte`:	Private structures
	`last-end`:	Public classes

R
	`read-buffer`:	Public classes

S
	`size`:	Public classes
	`Slot, bit-reader`:	Public classes
	`Slot, bits`:	Private structures
	`Slot, compress-buffer`:	Public classes
	`Slot, crc-high`:	Public classes
	`Slot, crc-low`:	Public classes
	`Slot, data-buffer`:	Public classes
	`Slot, deflate-stream`:	Public classes
	`Slot, input-buffer`:	Public classes
	`Slot, input-pos`:	Public classes
	`Slot, last-byte`:	Private structures
	`Slot, last-end`:	Public classes
	`Slot, read-buffer`:	Public classes
	`Slot, size`:	Public classes
	`Slot, stream`:	Private structures
	`Slot, underfile`:	Public classes
	`Slot, underlying-file`:	Public classes
	`Special Variable, base-distance`:	Private special variables
	`Special Variable, base-length`:	Private special variables
	`Special Variable, code-index`:	Private special variables
	`Special Variable, distance-extra-bits`:	Private special variables
	`Special Variable, fixed-huffman-distance-tree`:	Private special variables
	`Special Variable, fixed-huffman-tree`:	Private special variables
	`Special Variable, length-extra-bits`:	Private special variables
	`Special Variable, maskarray`:	Private special variables
	`Special Variable, if*-keyword-list`:	Private special variables
	`stream`:	Private structures

U
	`underfile`:	Public classes
	`underlying-file`:	Public classes

Z
	`z_deflated`:	Private constants

Jump to:	* + B C D G I L R S U Z

A.4 Data types

Jump to:	B C F G I P S

	Index Entry	Section

B
	`bit-reader`:	Private structures

C
	`Class, gzip-input-stream`:	Public classes
	`Class, gzip-output-stream`:	Public classes

F
	`File, gzip-stream.asd`:	The gzip-stream/gzip-stream․asd file
	`File, gzip-stream.lisp`:	The gzip-stream/gzip-stream․lisp file
	`File, gzip.lisp`:	The gzip-stream/gzip․lisp file
	`File, ifstar.lisp`:	The gzip-stream/ifstar․lisp file
	`File, inflate.lisp`:	The gzip-stream/inflate․lisp file
	`File, package.lisp`:	The gzip-stream/package․lisp file

G
	`gzip-input-stream`:	Public classes
	`gzip-output-stream`:	Public classes
	`gzip-stream`:	The gzip-stream system
	`gzip-stream`:	The gzip-stream package
	`gzip-stream.asd`:	The gzip-stream/gzip-stream․asd file
	`gzip-stream.lisp`:	The gzip-stream/gzip-stream․lisp file
	`gzip-system`:	The gzip-system package
	`gzip.lisp`:	The gzip-stream/gzip․lisp file

I
	`ifstar.lisp`:	The gzip-stream/ifstar․lisp file
	`inflate.lisp`:	The gzip-stream/inflate․lisp file

P
	`Package, gzip-stream`:	The gzip-stream package
	`Package, gzip-system`:	The gzip-system package
	`package.lisp`:	The gzip-stream/package․lisp file

S
	`Structure, bit-reader`:	Private structures
	`System, gzip-stream`:	The gzip-stream system

Jump to:	B C F G I P S

The gzip-stream Reference Manual

The gzip-stream Reference Manual

Table of Contents

1 Systems

1.1 gzip-stream

2 Files

2.1 Lisp

2.1.1 gzip-stream/gzip-stream.asd

2.1.2 gzip-stream/package.lisp

2.1.3 gzip-stream/ifstar.lisp

2.1.4 gzip-stream/inflate.lisp

2.1.5 gzip-stream/gzip-stream.lisp

2.1.6 gzip-stream/gzip.lisp

3 Packages

3.1 gzip-system

3.2 gzip-stream

4 Definitions

4.1 Public Interface

4.1.1 Macros

4.1.2 Ordinary functions

4.1.3 Generic functions

4.1.4 Standalone methods

4.1.5 Classes

4.2 Internals

4.2.1 Constants

4.2.2 Special variables

4.2.3 Macros

4.2.4 Ordinary functions

4.2.5 Generic functions

4.2.6 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `gzip-stream`

2.1.1 `gzip-stream/gzip-stream.asd`

2.1.2 `gzip-stream/package.lisp`

2.1.3 `gzip-stream/ifstar.lisp`

2.1.4 `gzip-stream/inflate.lisp`

2.1.5 `gzip-stream/gzip-stream.lisp`

2.1.6 `gzip-stream/gzip.lisp`

3.1 `gzip-system`

3.2 `gzip-stream`