This is the deoxybyte-gzip Reference Manual, version 0.6.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:16:43 2024 GMT+0.
deoxybyte-gzip/deoxybyte-gzip.asddeoxybyte-gzip/deoxybyte-gzip/package.lispdeoxybyte-gzip/deoxybyte-gzip/zlib-ffi.lispdeoxybyte-gzip/deoxybyte-gzip/rfc1952.lispdeoxybyte-gzip/deoxybyte-gzip/conditions.lispdeoxybyte-gzip/deoxybyte-gzip/deoxybyte-gzip.lispdeoxybyte-gzip/deoxybyte-gzip/gzip-stream.lispdeoxybyte-gzip/deoxybyte-gzip/line-stream.lispdeoxybyte-gzip/deoxybyte-gzip/sbcl.lispThe main system appears first, followed by any subsystem dependency.
deoxybyte-gzipKeith James
GPL v3
0.6.0
deoxybyte-systems (system)., at least version "1.0.0"
deoxybyte-io (system)., at least version "0.15.0"
deoxybyte-unix (system)., at least version "0.8.0"
deoxybyte-gzip (module).
Modules are listed depth-first from the system components tree.
deoxybyte-gzip/deoxybyte-gzipdeoxybyte-gzip (system).
package.lisp (file).
zlib-ffi.lisp (file).
rfc1952.lisp (file).
conditions.lisp (file).
deoxybyte-gzip.lisp (file).
gzip-stream.lisp (file).
line-stream.lisp (file).
sbcl.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
deoxybyte-gzip/deoxybyte-gzip.asddeoxybyte-gzip/deoxybyte-gzip/package.lispdeoxybyte-gzip/deoxybyte-gzip/zlib-ffi.lispdeoxybyte-gzip/deoxybyte-gzip/rfc1952.lispdeoxybyte-gzip/deoxybyte-gzip/conditions.lispdeoxybyte-gzip/deoxybyte-gzip/deoxybyte-gzip.lispdeoxybyte-gzip/deoxybyte-gzip/gzip-stream.lispdeoxybyte-gzip/deoxybyte-gzip/line-stream.lispdeoxybyte-gzip/deoxybyte-gzip/sbcl.lispdeoxybyte-gzip/deoxybyte-gzip.asddeoxybyte-gzip (system).
deoxybyte-gzip/deoxybyte-gzip/package.lispdeoxybyte-gzip (module).
deoxybyte-gzip/deoxybyte-gzip/zlib-ffi.lisppackage.lisp (file).
deoxybyte-gzip (module).
%adler32 (function).
%compress (function).
%compress2 (function).
%crc32 (function).
%deflate (function).
%deflate-init (function).
%deflate-init2 (function).
%inflate (function).
%inflate-init (function).
%inflate-init2 (function).
%uncompress (function).
*c-error-number* (symbol macro).
+z-buf-error+ (constant).
+z-data-error+ (constant).
+z-default-compression+ (constant).
+z-default-strategy+ (constant).
+z-deflated+ (constant).
+z-errno+ (constant).
+z-filtered+ (constant).
+z-finish+ (constant).
+z-full-flush+ (constant).
+z-huffman-only+ (constant).
+z-mem-error+ (constant).
+z-need-dict+ (constant).
+z-no-flush+ (constant).
+z-null+ (constant).
+z-ok+ (constant).
+z-stream-end+ (constant).
+z-stream-error+ (constant).
+z-version-error+ (constant).
deflate-end (function).
deflate-init (macro).
deflate-init2 (macro).
deflate-reset (function).
gzclose (function).
gzdopen (function).
gzeof (function).
gzerror (function).
gzflush (function).
gzgetc (function).
gzgets (function).
gzopen (function).
gzputc (function).
gzputs (function).
gzread (function).
gzseek (function).
gztell (function).
gzwrite (function).
inflate-end (function).
inflate-init (macro).
inflate-init2 (macro).
inflate-reset (function).
zlib-version (function).
%var-accessor-*c-error-number* (function).
(setf %var-accessor-*c-error-number*) (function).
+z-best-compression+ (constant).
+z-best-speed+ (constant).
+z-no-compression+ (constant).
+z-sync-flush+ (constant).
z-stream-tclass (class).
deoxybyte-gzip/deoxybyte-gzip/rfc1952.lispzlib-ffi.lisp (file).
deoxybyte-gzip (module).
+cm-deflate+ (constant).
+flag-comment+ (constant).
+flag-extra+ (constant).
+flag-fhcrc+ (constant).
+flag-name+ (constant).
+flag-text+ (constant).
+id1+ (constant).
+id2+ (constant).
+os-acorn-riscos+ (constant).
+os-amiga+ (constant).
+os-atari-tos+ (constant).
+os-cp/m+ (constant).
+os-fat-filesystem+ (constant).
+os-hpfs-filesystem+ (constant).
+os-macintosh+ (constant).
+os-ntfs-filesystem+ (constant).
+os-qdos+ (constant).
+os-tops-20+ (constant).
+os-unix+ (constant).
+os-unknown+ (constant).
+os-vm/cms+ (constant).
+os-vms+ (constant).
+os-z-system+ (constant).
+xfl-fastest+ (constant).
+xfl-slowest+ (constant).
gz-member (structure).
gz-member-cdata (reader).
(setf gz-member-cdata) (writer).
gz-member-cend (reader).
(setf gz-member-cend) (writer).
gz-member-cm (reader).
gz-member-crc32 (reader).
(setf gz-member-crc32) (writer).
gz-member-flg (reader).
(setf gz-member-flg) (writer).
gz-member-id1 (reader).
gz-member-id2 (reader).
gz-member-isize (reader).
(setf gz-member-isize) (writer).
gz-member-mtime (reader).
(setf gz-member-mtime) (writer).
gz-member-os (reader).
(setf gz-member-os) (writer).
gz-member-xfl (reader).
(setf gz-member-xfl) (writer).
gz-member-xlen (reader).
(setf gz-member-xlen) (writer).
make-gz-member (function).
copy-gz-member (function).
gz-member-p (function).
deoxybyte-gzip/deoxybyte-gzip/conditions.lisprfc1952.lisp (file).
deoxybyte-gzip (module).
gz-io-error (condition).
zlib-error (condition).
errno-of (reader method).
deoxybyte-gzip/deoxybyte-gzip/deoxybyte-gzip.lispconditions.lisp (file).
deoxybyte-gzip (module).
adler32 (function).
compress (function).
crc32 (function).
deflate-stream (function).
deflate-vector (function).
gunzip (function).
gunzip-pathname (function).
gz (structure).
gz-close (function).
gz-eof-p (function).
gz-open (function).
gz-read (function).
gz-read-byte (function).
gz-read-string (function).
gz-write (function).
gz-write-byte (function).
gz-write-string (function).
gzip (function).
gzip-pathname (function).
inflate-stream (function).
inflate-vector (function).
uncompress (function).
with-gz-file (macro).
+default-zlib-buffer-size+ (constant).
copy-gz (function).
empty-to-stream (function).
fill-from-stream (function).
gz-error (function).
gz-error-message (function).
gz-flush (function).
gz-open-p (reader).
(setf gz-open-p) (writer).
gz-p (function).
gz-ptr (reader).
(setf gz-ptr) (writer).
gz-seek (function).
gz-tell (function).
make-gz (function).
make-z-stream (function).
z-error (function).
z-stream-close (function).
z-stream-open (function).
z-stream-operation (function).
z-vector-operation (function).
deoxybyte-gzip/deoxybyte-gzip/gzip-stream.lispdeoxybyte-gzip.lisp (file).
deoxybyte-gzip (module).
gzip-input-stream (class).
gzip-open (function).
gzip-output-stream (class).
gzip-stream (class).
open-stream-p (method).
stream-clear-input (method).
stream-clear-output (method).
stream-close (method).
stream-element-type (method).
stream-file-position (method).
stream-finish-output (method).
stream-force-output (method).
stream-read-byte (method).
stream-write-byte (method).
with-open-gzip (macro).
%stream-read-sequence (function).
%stream-write-sequence (function).
+octet-buffer-size+ (constant).
octet-buffer (type).
octet-buffer-index (type).
deoxybyte-gzip/deoxybyte-gzip/line-stream.lispgzip-stream.lisp (file).
deoxybyte-gzip (module).
gzip-line-input-stream (class).
more-lines-p (method).
stream-clear-input (method).
stream-element-type (method).
stream-file-position (method).
stream-read-line (method).
stream-read-sequence (method).
%line-stream-read-sequence (function).
%line-stream-write-sequence (function).
read-octet-line (function).
stream-delete-file (method).
deoxybyte-gzip/deoxybyte-gzip/sbcl.lispline-stream.lisp (file).
deoxybyte-gzip (module).
stream-read-sequence (method).
stream-write-sequence (method).
Packages are listed by definition order.
zlib-ffiThe 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.
cffi.
common-lisp.
%adler32 (function).
%compress (function).
%compress2 (function).
%crc32 (function).
%deflate (function).
%deflate-init (function).
%deflate-init2 (function).
%inflate (function).
%inflate-init (function).
%inflate-init2 (function).
%uncompress (function).
*c-error-number* (symbol macro).
+z-buf-error+ (constant).
+z-data-error+ (constant).
+z-default-compression+ (constant).
+z-default-strategy+ (constant).
+z-deflated+ (constant).
+z-errno+ (constant).
+z-filtered+ (constant).
+z-finish+ (constant).
+z-full-flush+ (constant).
+z-huffman-only+ (constant).
+z-mem-error+ (constant).
+z-need-dict+ (constant).
+z-no-flush+ (constant).
+z-null+ (constant).
+z-ok+ (constant).
+z-stream-end+ (constant).
+z-stream-error+ (constant).
+z-version-error+ (constant).
deflate-end (function).
deflate-init (macro).
deflate-init2 (macro).
deflate-reset (function).
gzclose (function).
gzdopen (function).
gzeof (function).
gzerror (function).
gzflush (function).
gzgetc (function).
gzgets (function).
gzopen (function).
gzputc (function).
gzputs (function).
gzread (function).
gzseek (function).
gztell (function).
gzwrite (function).
inflate-end (function).
inflate-init (macro).
inflate-init2 (macro).
inflate-reset (function).
zlib-version (function).
%var-accessor-*c-error-number* (function).
(setf %var-accessor-*c-error-number*) (function).
+z-best-compression+ (constant).
+z-best-speed+ (constant).
+z-no-compression+ (constant).
+z-sync-flush+ (constant).
z-stream-tclass (class).
uk.co.deoxybyte-gzipThe 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.
deoxybyte-gzip
gz
cffi.
common-lisp.
uk.co.deoxybyte-io.
uk.co.deoxybyte-utilities.
zlib-ffi.
+cm-deflate+ (constant).
+flag-comment+ (constant).
+flag-extra+ (constant).
+flag-fhcrc+ (constant).
+flag-name+ (constant).
+flag-text+ (constant).
+id1+ (constant).
+id2+ (constant).
+os-acorn-riscos+ (constant).
+os-amiga+ (constant).
+os-atari-tos+ (constant).
+os-cp/m+ (constant).
+os-fat-filesystem+ (constant).
+os-hpfs-filesystem+ (constant).
+os-macintosh+ (constant).
+os-ntfs-filesystem+ (constant).
+os-qdos+ (constant).
+os-tops-20+ (constant).
+os-unix+ (constant).
+os-unknown+ (constant).
+os-vm/cms+ (constant).
+os-vms+ (constant).
+os-z-system+ (constant).
+xfl-fastest+ (constant).
+xfl-slowest+ (constant).
adler32 (function).
compress (function).
crc32 (function).
deflate-stream (function).
deflate-vector (function).
gunzip (function).
gunzip-pathname (function).
gz (structure).
gz-close (function).
gz-eof-p (function).
gz-io-error (condition).
gz-member (structure).
gz-member-cdata (reader).
(setf gz-member-cdata) (writer).
gz-member-cend (reader).
(setf gz-member-cend) (writer).
gz-member-cm (reader).
gz-member-crc32 (reader).
(setf gz-member-crc32) (writer).
gz-member-flg (reader).
(setf gz-member-flg) (writer).
gz-member-id1 (reader).
gz-member-id2 (reader).
gz-member-isize (reader).
(setf gz-member-isize) (writer).
gz-member-mtime (reader).
(setf gz-member-mtime) (writer).
gz-member-os (reader).
(setf gz-member-os) (writer).
gz-member-xfl (reader).
(setf gz-member-xfl) (writer).
gz-member-xlen (reader).
(setf gz-member-xlen) (writer).
gz-open (function).
gz-read (function).
gz-read-byte (function).
gz-read-string (function).
gz-write (function).
gz-write-byte (function).
gz-write-string (function).
gzip (function).
gzip-input-stream (class).
gzip-line-input-stream (class).
gzip-open (function).
gzip-output-stream (class).
gzip-pathname (function).
gzip-stream (class).
inflate-stream (function).
inflate-vector (function).
make-gz-member (function).
uncompress (function).
with-gz-file (macro).
with-open-gzip (macro).
zlib-error (condition).
%line-stream-read-sequence (function).
%line-stream-write-sequence (function).
%stream-read-sequence (function).
%stream-write-sequence (function).
+default-zlib-buffer-size+ (constant).
+octet-buffer-size+ (constant).
copy-gz (function).
copy-gz-member (function).
empty-to-stream (function).
errno-of (generic reader).
fill-from-stream (function).
gz-error (function).
gz-error-message (function).
gz-flush (function).
gz-member-p (function).
gz-open-p (reader).
(setf gz-open-p) (writer).
gz-p (function).
gz-ptr (reader).
(setf gz-ptr) (writer).
gz-seek (function).
gz-tell (function).
make-gz (function).
make-z-stream (function).
octet-buffer (type).
octet-buffer-index (type).
read-octet-line (function).
stream-delete-file (generic function).
z-error (function).
z-stream-close (function).
z-stream-open (function).
z-stream-operation (function).
z-vector-operation (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
CM (Compression Method)
FLG (FLaGs) FCOMMENT
FLG (FLaGs) FEXTRA
FLG (FLaGs) FHCRC
FLG (FLaGs) FNAME
FLG (FLaGs) FTEXT
ID1 (IDentification 1)
ID2 (IDentification 2)
XFL (eXtra FLags) compressor used fastest algorithm
XFL (eXtra FLags) compressor used maximum compression, slowest algorithm
Compression method
No error.
Macro that emulates Zlib’s deflateInit.
Macro that emulates Zlib’s deflateInit2.
Macro that emulates Zlib’s inflateInit.
Macro that emulates Zlib’s inflateInit2.
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.
Compresses bytes in array SOURCE to array DEST, returning DEST and the compressed size in bytes.
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.
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).
Decompresses IN-FILESPEC to OUT-FILESPEC using the default compression level. Returns two values, OUT-FILESPEC and the number of bytes decompressed.
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
Closes GZ, if open.
Returns T if GZ has reached EOF, or NIL otherwise.
cend.
flg.
os.
xfl.
xlen.
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.
Reads up to N bytes from GZ into octet vector BUFFER. Returns the number of bytes read, which may be 0.
Returns a byte read from GZ, or :eof .
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.
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.
Writes BYTE to GZ and returns BYTE.
Writes up to N characters in octet vector BUFFER to GZ. Returns the number of characters written.
Compresses IN-FILESPEC to OUT-FILESPEC using the default compression level. Returns two values, OUT-FILESPEC and the number of bytes compressed.
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}
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
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.
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).
Uncompresses bytes in array SOURCE to array DEST, returning DEST and the compressed size in bytes.
gzip-line-input-stream)) ¶uk.co.deoxybyte-io.
gzip-stream)) ¶gzip-input-stream)) ¶sb-gray.
gzip-line-input-stream)) ¶sb-gray.
gzip-output-stream)) ¶sb-gray.
gzip-stream) &key abort) ¶uk.co.deoxybyte-io.
gzip-stream)) ¶gzip-line-input-stream)) ¶gzip-stream) &optional position) ¶sb-gray.
gzip-line-input-stream) &optional position) ¶sb-gray.
gzip-output-stream)) ¶sb-gray.
gzip-output-stream)) ¶sb-gray.
gzip-input-stream)) ¶sb-gray.
gzip-line-input-stream)) ¶sb-gray.
gzip-input-stream) (seq sequence) &optional start end) ¶sb-gray.
gzip-line-input-stream) sequence &optional start end) ¶sb-gray.
gzip-output-stream) (byte fixnum)) ¶sb-gray.
gzip-output-stream) (seq sequence) &optional start end) ¶sb-gray.
A condition raised when a gzip error occurs.
io-error.
zlib-error.
A condition raised when a zlib error occurs.
error.
simple-text-condition.
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.
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.
structure-object.
uk.co.deoxybyte-utilities:uint8
uk.co.deoxybyte-gzip:+id1+
This slot is read-only.
uk.co.deoxybyte-utilities:uint8
uk.co.deoxybyte-gzip:+id2+
This slot is read-only.
uk.co.deoxybyte-utilities:uint8
uk.co.deoxybyte-gzip:+cm-deflate+
This slot is read-only.
uk.co.deoxybyte-utilities:uint8
uk.co.deoxybyte-gzip:+flag-extra+
uk.co.deoxybyte-utilities:uint32
0
uk.co.deoxybyte-utilities:uint8
0
uk.co.deoxybyte-utilities:uint8
uk.co.deoxybyte-gzip:+os-unknown+
uk.co.deoxybyte-utilities:uint16
0
uk.co.deoxybyte-utilities:uint32
0
uk.co.deoxybyte-utilities:uint32
0
uk.co.deoxybyte-utilities:simple-octet-vector
(make-array 0 :element-type (quote uk.co.deoxybyte-utilities:octet))
uk.co.deoxybyte-utilities:uint32
0
A stream that reads bytes from a compressed stream.
fundamental-binary-input-stream.
gzip-stream.
gzip-stream.
line-input-stream.
The buffer from which lines are read.
(make-array uk.co.deoxybyte-gzip::+octet-buffer-size+ :element-type (quote uk.co.deoxybyte-utilities:octet) :initial-element 0)
:buffer
The end of line character code. If two characters are used, this is the first of the pair.
(char-code #\newline)
:eol-code
The number of bytes that were read into the buffer from the stream.
0
The offset in the byte buffer from which the next byte is to be read.
0
:filespec
:gz
A stream that writes characters to a compressed stream.
fundamental-binary-output-stream.
gzip-stream.
A gzip stream capable of reading or writing compressed data.
fundamental-stream.
The gzip handle.
:gz
(make-array uk.co.deoxybyte-gzip::+octet-buffer-size+ :element-type (quote uk.co.deoxybyte-utilities:octet) :initial-element (char-code #\.))
:buffer
common-lisp.
t
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.
Returns a zlib error message string relevant to GZ.
Makes an returns a new Z-STREAM with the ZALLOC, ZFREE and OPAQUE slots filled with null-pointers.
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.
Raises a {define-condition zlib-error} . A MESSAGE string may be supplied, otherwise it will be determined from ERRNO.
Signals the end of OPERATION (:inflate or :deflate) on Z-STREAM and frees the Z-STREAM memory.
Returns a new Z-STREAM initialised for OPERATION (:inflate or :deflate).
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.
zlib-error)) ¶gzip-line-input-stream)) ¶foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
A C D E F G I M O R S U W Z |
|---|
| Jump to: | %
(
A C D E F G I M O R S U W Z |
|---|
| Jump to: | *
+
B C E F G I M N O P S X |
|---|
| Jump to: | *
+
B C E F G I M N O P S X |
|---|
| Jump to: | C D F G L M O P R S T U Z |
|---|
| Jump to: | C D F G L M O P R S T U Z |
|---|