This is the lzlib Reference Manual, version 2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:25:38 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
Modules are listed depth-first from the system components tree.
lzlib/srclzlib (system).
package.lisp (file).
lzlib.lisp (file).
lzip.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
lzlib/src/lzlib.lisppackage.lisp (file).
src (module).
+lz-bad-argument+ (constant).
+lz-data-error+ (constant).
+lz-header-error+ (constant).
+lz-library-error+ (constant).
+lz-mem-error+ (constant).
+lz-ok+ (constant).
+lz-sequence-error+ (constant).
+lz-unexpected-eof+ (constant).
i32 (type).
lz-compress-close (function).
lz-compress-data-position (function).
lz-compress-errno (function).
lz-compress-finish (function).
lz-compress-finished (function).
lz-compress-member-finished (function).
lz-compress-member-position (function).
lz-compress-open (function).
lz-compress-read (function).
lz-compress-restart-member (function).
lz-compress-sync-flush (function).
lz-compress-total-in-size (function).
lz-compress-total-out-size (function).
lz-compress-write (function).
lz-compress-write-size (function).
lz-decompress-close (function).
lz-decompress-data-crc (function).
lz-decompress-data-position (function).
lz-decompress-dictionary-size (function).
lz-decompress-errno (function).
lz-decompress-finish (function).
lz-decompress-finished (function).
lz-decompress-member-finished (function).
lz-decompress-member-position (function).
lz-decompress-member-version (function).
lz-decompress-open (function).
lz-decompress-read (function).
lz-decompress-reset (function).
lz-decompress-sync-to-member (function).
lz-decompress-total-in-size (function).
lz-decompress-total-out-size (function).
lz-decompress-write (function).
lz-decompress-write-size (function).
lz-max-dictionary-bits (function).
lz-max-dictionary-size (function).
lz-max-match-len-limit (function).
lz-min-dictionary-bits (function).
lz-min-dictionary-size (function).
lz-min-match-len-limit (function).
lz-strerror (function).
lz-version (function).
u32 (type).
u64 (type).
lzlib/src/lzip.lisplzlib.lisp (file).
src (module).
close (method).
close (method).
compress-buffer (function).
compress-file (function).
compress-stream (function).
decompress-buffer (function).
decompress-file (function).
decompress-stream (function).
lzlib-error (condition).
make-compressing-stream (function).
make-decompressing-stream (function).
stream-element-type (method).
stream-element-type (method).
stream-finish-output (method).
stream-listen (method).
stream-read-byte (method).
stream-read-sequence (method).
stream-write-byte (method).
stream-write-sequence (method).
with-compressing-stream (macro).
with-decompressing-stream (macro).
+buffer-size+ (constant).
buffer (reader method).
buffer (reader method).
(setf buffer) (writer method).
(setf buffer) (writer method).
compress-and-write (function).
compress-stream-1 (function).
compress-stream-n (function).
compressing-stream (class).
decoder (reader method).
(setf decoder) (writer method).
decompress-stream-1 (function).
decompress-stream-n (function).
decompressing-stream (class).
encoder (reader method).
(setf encoder) (writer method).
first-member (reader method).
(setf first-member) (writer method).
ignore-trailing (reader method).
(setf ignore-trailing) (writer method).
input-stream (reader method).
(setf input-stream) (writer method).
loose-trailing (reader method).
(setf loose-trailing) (writer method).
lz-error (macro).
lzma-options (function).
member-size (reader method).
(setf member-size) (writer method).
output (reader method).
(setf output) (writer method).
output-index (reader method).
(setf output-index) (writer method).
output-stream (reader method).
(setf output-stream) (writer method).
process-decompression-error (function).
read-and-decompress (function).
u8 (type).
Packages are listed by definition order.
lzlibcommon-lisp.
trivial-gray-streams.
compress-buffer (function).
compress-file (function).
compress-stream (function).
decompress-buffer (function).
decompress-file (function).
decompress-stream (function).
lzlib-error (condition).
make-compressing-stream (function).
make-decompressing-stream (function).
with-compressing-stream (macro).
with-decompressing-stream (macro).
+buffer-size+ (constant).
+lz-bad-argument+ (constant).
+lz-data-error+ (constant).
+lz-header-error+ (constant).
+lz-library-error+ (constant).
+lz-mem-error+ (constant).
+lz-ok+ (constant).
+lz-sequence-error+ (constant).
+lz-unexpected-eof+ (constant).
buffer (generic reader).
(setf buffer) (generic writer).
compress-and-write (function).
compress-stream-1 (function).
compress-stream-n (function).
compressing-stream (class).
decoder (generic reader).
(setf decoder) (generic writer).
decompress-stream-1 (function).
decompress-stream-n (function).
decompressing-stream (class).
encoder (generic reader).
(setf encoder) (generic writer).
first-member (generic reader).
(setf first-member) (generic writer).
i32 (type).
ignore-trailing (generic reader).
(setf ignore-trailing) (generic writer).
input-stream (generic reader).
(setf input-stream) (generic writer).
loose-trailing (generic reader).
(setf loose-trailing) (generic writer).
lz-compress-close (function).
lz-compress-data-position (function).
lz-compress-errno (function).
lz-compress-finish (function).
lz-compress-finished (function).
lz-compress-member-finished (function).
lz-compress-member-position (function).
lz-compress-open (function).
lz-compress-read (function).
lz-compress-restart-member (function).
lz-compress-sync-flush (function).
lz-compress-total-in-size (function).
lz-compress-total-out-size (function).
lz-compress-write (function).
lz-compress-write-size (function).
lz-decompress-close (function).
lz-decompress-data-crc (function).
lz-decompress-data-position (function).
lz-decompress-dictionary-size (function).
lz-decompress-errno (function).
lz-decompress-finish (function).
lz-decompress-finished (function).
lz-decompress-member-finished (function).
lz-decompress-member-position (function).
lz-decompress-member-version (function).
lz-decompress-open (function).
lz-decompress-read (function).
lz-decompress-reset (function).
lz-decompress-sync-to-member (function).
lz-decompress-total-in-size (function).
lz-decompress-total-out-size (function).
lz-decompress-write (function).
lz-decompress-write-size (function).
lz-error (macro).
lz-max-dictionary-bits (function).
lz-max-dictionary-size (function).
lz-max-match-len-limit (function).
lz-min-dictionary-bits (function).
lz-min-dictionary-size (function).
lz-min-match-len-limit (function).
lz-strerror (function).
lz-version (function).
lzma-options (function).
member-size (generic reader).
(setf member-size) (generic writer).
output (generic reader).
(setf output) (generic writer).
output-index (generic reader).
(setf output-index) (generic writer).
output-stream (generic reader).
(setf output-stream) (generic writer).
process-decompression-error (function).
read-and-decompress (function).
u32 (type).
u64 (type).
u8 (type).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Within BODY, STREAM is bound to a compressing stream for the given compression LEVEL and OUTPUT-STREAM. The result of the last form of BODY is returned.
Within BODY, STREAM is bound to a decompressing stream for the given INPUT-STREAM. The result of the last form of BODY is returned.
Read the data between the START and END offsets in the BUFFER, compress it, and return the resulting octet vector.
Read the data from the INPUT file, compress it, and write the result to the OUTPUT file.
Read the data from the INPUT octet stream, compress it, and write the result to the OUTPUT octet stream.
Read the data between the START and END offsets in the BUFFER, decompress it, and return the resulting octet vector.
Read the data from the INPUT file, decompress it, and write the result to the OUTPUT file.
Read the data from the INPUT octet stream, decompress it, and write the result to the OUTPUT octet stream.
Return a stream that will compress the bytes written to it at the given compression LEVEL and write them to the OUTPUT-STREAM.
Return a stream that will supply the bytes resulting from the decompression of the data read from the INPUT-STREAM.
decompressing-stream) &key &allow-other-keys) ¶compressing-stream) &key &allow-other-keys) ¶decompressing-stream)) ¶compressing-stream)) ¶compressing-stream)) ¶sb-gray.
decompressing-stream)) ¶sb-gray.
decompressing-stream)) ¶sb-gray.
decompressing-stream) seq start end &key &allow-other-keys) ¶trivial-gray-streams.
compressing-stream) byte) ¶sb-gray.
compressing-stream) seq start end &key &allow-other-keys) ¶trivial-gray-streams.
At least one of the arguments passed to the library function was invalid.
The data stream is corrupt. If ’LZ_decompress_member_position’ is 6 or less, it indicates either a format version not supported, an invalid dictionary size, a corrupt header in a multimember data stream, or trailing data too similar to a valid lzip header. Lziprecover can be used to remove conflicting trailing data from a file.
An invalid member header (one with the wrong magic bytes) was read. If this happens at the end of the data stream it may indicate trailing data.
A bug was detected in the library.
No memory available. The system cannot allocate more virtual memory because its capacity is full.
The value of this constant is 0 and is used to indicate that there is no error.
A library function was called in the wrong order. For example ’LZ_compress_restart_member’ was called before ’LZ_compress_member_finished’ indicates that the current member is finished.
The end of the data stream was reached in the middle of a member.
Read the data from the INPUT octet stream, compress it, and write the result to the OUTPUT octet stream.
Read the data from the INPUT octet stream, compress it using multiple threads, and write the result to the OUTPUT octet stream.
Read the data from the INPUT octet stream, decompress it, and write the result to the OUTPUT octet stream.
Read the data from the INPUT octet stream, decompress it using multiple threads, and write the result to the OUTPUT octet stream.
Frees all dynamically allocated data structures for this stream. This function discards any unprocessed input and does not flush any pending output. After a call to ’LZ_compress_close’, encoder can no longer be used as an argument to any LZ_compress function.
Returns the number of input bytes already compressed in the current member.
Returns the current error code for encoder.
Use this function to tell ’lzlib’ that all the data for this member have already been written (with the ’LZ_compress_write’ function). It is safe to call ’LZ_compress_finish’ as many times as needed. After all the produced compressed data have been read with ’LZ_compress_read’ and ’LZ_compress_member_finished’ returns 1, a new member can be started with ’LZ_compress_restart_member’.
Returns 1 if all the data have been read and ’LZ_compress_close’ can be safely called. Otherwise it returns 0. ’LZ_compress_finished’ implies ’LZ_compress_member_finished’.
Returns 1 if the current member, in a multimember data stream, has been fully read and ’LZ_compress_restart_member’ can be safely called. Otherwise it returns 0.
Returns the number of compressed bytes already produced, but perhaps not yet read, in the current member.
Initializes the internal stream state for compression and returns a pointer that can only be used as the encoder argument for the other LZ_compress functions, or a null pointer if the encoder could not be allocated. The returned pointer must be verified by calling ’LZ_compress_errno’ before using it. If ’LZ_compress_errno’ does not return ’LZ_ok’, the returned pointer must not be used and should be freed with ’LZ_compress_close’ to avoid memory leaks. dictionary_size sets the dictionary size to be used, in bytes. Valid values range from 4 KiB to 512 MiB. Note that dictionary sizes are quantized. If the specified size does not match one of the valid sizes, it will be rounded upwards by adding up to (dictionary_size / 8) to it. match_len_limit sets the match length limit in bytes. Valid values range from 5 to 273. Larger values usually give better compression ratios but longer compression times. If dictionary_size is 65535 and match_len_limit is 16, the fast variant of LZMA is chosen, which produces identical compressed output as lzip -0. (The dictionary size used will be rounded upwards to 64 KiB). member_size sets the member size limit in bytes. Valid values range from 100 kB to 2 PiB. Small member size may degrade compression ratio, so use it only when needed. To produce a single-member data stream, give member_size a value larger than the amount of data to be produced. Values larger than 2 PiB will be reduced to 2 PiB to prevent the uncompressed size of the member from overflowing.
The ’LZ_compress_read’ function reads up to size bytes from the stream pointed to by encoder, storing the results in buffer. The return value is the number of bytes actually read. This might be less than size; for example, if there aren’t that many bytes left in the stream or if more bytes have to be yet written with the ’LZ_compress_write’ function. Note that reading less than size bytes is not an error.
Use this function to start a new member in a multimember data stream. Call this function only after ’LZ_compress_member_finished’ indicates that the current member has been fully read (with the ’LZ_compress_read’ function).
Use this function to make available to ’LZ_compress_read’ all the data already written with the ’LZ_compress_write’ function. First call ’LZ_compress_sync_flush’. Then call ’LZ_compress_read’ until it returns 0. Repeated use of ’LZ_compress_sync_flush’ may degrade compression ratio, so use it only when needed.
Returns the total number of input bytes already compressed.
Returns the total number of compressed bytes already produced, but perhaps not yet read.
The ’LZ_compress_write’ function writes up to size bytes from buffer to the stream pointed to by encoder. The return value is the number of bytes actually written. This might be less than size. Note that writing less than size bytes is not an error.
The ’LZ_compress_write_size’ function returns the maximum number of bytes that can be immediately written through the ’LZ_compress_write’ function. It is guaranteed that an immediate call to ’LZ_compress_write’ will accept a size up to the returned number of bytes.
Frees all dynamically allocated data structures for this stream. This function discards any unprocessed input and does not flush any pending output. After a call to ’LZ_decompress_close’, decoder can no longer be used as an argument to any LZ_decompress function.
Returns the 32 bit Cyclic Redundancy Check of the data decompressed from the current member. The returned value is valid only when ’LZ_decompress_member_finished’ returns 1.
Returns the number of decompressed bytes already produced, but perhaps not yet read, in the current member.
Returns the dictionary size of current member from member header.
Returns the current error code for decoder.
Use this function to tell ’lzlib’ that all the data for this stream have already been written (with the ’LZ_decompress_write’ function). It is safe to call ’LZ_decompress_finish’ as many times as needed.
Returns 1 if all the data have been read and ’LZ_decompress_close’ can be safely called. Otherwise it returns 0.
Returns 1 if the previous call to ’LZ_decompress_read’ finished reading the current member, indicating that final values for member are available through ’LZ_decompress_data_crc’, ’LZ_decompress_data_position’, and ’LZ_decompress_member_position’. Otherwise it returns 0.
Returns the number of input bytes already decompressed in the current member.
Returns the version of current member from member header.
Initializes the internal stream state for decompression and returns a pointer that can only be used as the decoder argument for the other LZ_decompress functions, or a null pointer if the decoder could not be allocated. The returned pointer must be verified by calling ’LZ_decompress_errno’ before using it. If ’LZ_decompress_errno’ does not return ’LZ_ok’, the returned pointer must not be used and should be freed with ’LZ_decompress_close’ to avoid memory leaks.
The ’LZ_decompress_read’ function reads up to size bytes from the stream pointed to by decoder, storing the results in buffer. The return value is the number of bytes actually read. This might be less than size; for example, if there aren’t that many bytes left in the stream or if more bytes have to be yet written with the ’LZ_decompress_write’ function. Note that reading less than size bytes is not an error. In case of decompression error caused by corrupt or truncated data, ’LZ_decompress_read’ does not signal the error immediately to the application, but waits until all decoded bytes have been read. This allows tools like tarlz to recover as much data as possible from each damaged member.
Resets the internal state of decoder as it was just after opening it with the ’LZ_decompress_open’ function. Data stored in the internal buffers is discarded. Position counters are set to 0.
Resets the error state of decoder and enters a search state that lasts until a new member header (or the end of the stream) is found. After a successful call to ’LZ_decompress_sync_to_member’, data written with ’LZ_decompress_write’ will be consumed and ’LZ_decompress_read’ will return 0 until a header is found. This function is useful to discard any data preceding the first member, or to discard the rest of the current member, for example in case of a data error. If the decoder is already at the beginning of a member, this function does nothing.
Returns the total number of input bytes already decompressed.
Returns the total number of decompressed bytes already produced, but perhaps not yet read.
The ’LZ_decompress_write’ function writes up to size bytes from buffer to the stream pointed to by decoder. The return value is the number of bytes actually written. This might be less than size. Note that writing less than size bytes is not an error.
The ’LZ_decompress_write_size’ function returns the maximum number of bytes that can be immediately written through the ’LZ_decompress_write’ function. It is guaranteed that an immediate call to ’LZ_decompress_write’ will accept a size up to the returned number of bytes.
Returns the base 2 logarithm of the largest valid dictionary size.
Returns the largest valid dictionary size.
Returns the largest valid match length limit.
Returns the base 2 logarithm of the smallest valid dictionary size.
Returns the smallest valid dictionary size.
Returns the smallest valid match length limit.
Returns the standard error message for a given error code. The messages are fairly short; there are no multi-line messages or embedded newlines. This function makes it easy for your program to report informative error messages about the failure of a library call. The value of lz_errno normally comes from a call to ’LZ_(de)compress_errno’.
Returns the library version as a string.
Get the LZMA parameters matching the given arguments.
decompressing-stream)) ¶automatically generated reader method
compressing-stream)) ¶automatically generated reader method
decompressing-stream)) ¶automatically generated writer method
compressing-stream)) ¶automatically generated writer method
decompressing-stream)) ¶automatically generated reader method
decompressing-stream)) ¶automatically generated writer method
compressing-stream)) ¶automatically generated reader method
compressing-stream)) ¶automatically generated writer method
decompressing-stream)) ¶automatically generated reader method
decompressing-stream)) ¶automatically generated writer method
decompressing-stream)) ¶automatically generated reader method
decompressing-stream)) ¶automatically generated writer method
decompressing-stream)) ¶automatically generated reader method
decompressing-stream)) ¶automatically generated writer method
decompressing-stream)) ¶automatically generated reader method
decompressing-stream)) ¶automatically generated writer method
compressing-stream)) ¶automatically generated reader method
compressing-stream)) ¶automatically generated writer method
decompressing-stream)) ¶automatically generated reader method
decompressing-stream)) ¶automatically generated writer method
decompressing-stream)) ¶automatically generated reader method
decompressing-stream)) ¶automatically generated writer method
compressing-stream)) ¶automatically generated reader method
compressing-stream)) ¶automatically generated writer method
fundamental-binary-input-stream.
(setf buffer).
buffer.
close.
(setf decoder).
decoder.
(setf first-member).
first-member.
(setf ignore-trailing).
ignore-trailing.
(setf input-stream).
input-stream.
(setf loose-trailing).
loose-trailing.
(setf output).
output.
(setf output-index).
output-index.
stream-element-type.
stream-listen.
stream-read-byte.
stream-read-sequence.
| Jump to: | (
B C D E F G I L M O P R S W |
|---|
| Jump to: | (
B C D E F G I L M O P R S W |
|---|
| Jump to: | +
B C D E F I L M O S |
|---|
| Jump to: | +
B C D E F I L M O S |
|---|
| Jump to: | C D F I L M P S T U |
|---|
| Jump to: | C D F I L M P S T U |
|---|