This is the zstd Reference Manual, version 2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:34:56 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
Modules are listed depth-first from the system components tree.
zstd/src
zstd
(system).
package.lisp
(file).
libzstd.lisp
(file).
zstd.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
zstd/src/libzstd.lisp
package.lisp
(file).
src
(module).
i32
(type).
u32
(type).
u64
(type).
zstd-c-stream-in-size
(function).
zstd-c-stream-out-size
(function).
zstd-cctx-set-parameter
(function).
zstd-compress-stream2
(function).
zstd-create-cctx
(function).
zstd-create-dctx
(function).
zstd-d-stream-in-size
(function).
zstd-d-stream-out-size
(function).
zstd-decompress-stream
(function).
zstd-free-cctx
(function).
zstd-free-dctx
(function).
zstd-get-error-name
(function).
zstd-in-buffer-tclass
(class).
zstd-is-error
(function).
zstd-max-c-level
(function).
zstd-min-c-level
(function).
zstd-out-buffer-tclass
(class).
zstd/src/zstd.lisp
libzstd.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).
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).
zstd-error
(macro).
zstd-error
(condition).
+buffer-size+
(constant).
compress-and-write
(function).
compressing-stream
(class).
decompressing-stream
(class).
frame-complete-p
(reader method).
(setf frame-complete-p)
(writer method).
initialize-context
(function).
input-buffer
(reader method).
input-buffer
(reader method).
(setf input-buffer)
(writer method).
(setf input-buffer)
(writer method).
input-stream
(reader method).
(setf input-stream)
(writer method).
output-buffer
(reader method).
output-buffer
(reader method).
(setf output-buffer)
(writer method).
(setf output-buffer)
(writer method).
output-stream
(reader method).
(setf output-stream)
(writer method).
read-and-decompress
(function).
u8
(type).
zstd-check
(macro).
zstd-context
(reader method).
zstd-context
(reader method).
(setf zstd-context)
(writer method).
(setf zstd-context)
(writer method).
zstd-in-buffer
(reader method).
zstd-in-buffer
(reader method).
(setf zstd-in-buffer)
(writer method).
(setf zstd-in-buffer)
(writer method).
zstd-out-buffer
(reader method).
zstd-out-buffer
(reader method).
(setf zstd-out-buffer)
(writer method).
(setf zstd-out-buffer)
(writer method).
Packages are listed by definition order.
zstd
common-lisp
.
trivial-gray-streams
.
compress-buffer
(function).
compress-file
(function).
compress-stream
(function).
decompress-buffer
(function).
decompress-file
(function).
decompress-stream
(function).
make-compressing-stream
(function).
make-decompressing-stream
(function).
with-compressing-stream
(macro).
with-decompressing-stream
(macro).
zstd-error
(macro).
zstd-error
(condition).
+buffer-size+
(constant).
compress-and-write
(function).
compressing-stream
(class).
decompressing-stream
(class).
frame-complete-p
(generic reader).
(setf frame-complete-p)
(generic writer).
i32
(type).
initialize-context
(function).
input-buffer
(generic reader).
(setf input-buffer)
(generic writer).
input-stream
(generic reader).
(setf input-stream)
(generic writer).
output-buffer
(generic reader).
(setf output-buffer)
(generic writer).
output-stream
(generic reader).
(setf output-stream)
(generic writer).
read-and-decompress
(function).
u32
(type).
u64
(type).
u8
(type).
zstd-c-stream-in-size
(function).
zstd-c-stream-out-size
(function).
zstd-cctx-set-parameter
(function).
zstd-check
(macro).
zstd-compress-stream2
(function).
zstd-context
(generic reader).
(setf zstd-context)
(generic writer).
zstd-create-cctx
(function).
zstd-create-dctx
(function).
zstd-d-stream-in-size
(function).
zstd-d-stream-out-size
(function).
zstd-decompress-stream
(function).
zstd-free-cctx
(function).
zstd-free-dctx
(function).
zstd-get-error-name
(function).
zstd-in-buffer
(generic reader).
(setf zstd-in-buffer)
(generic writer).
zstd-in-buffer-tclass
(class).
zstd-is-error
(function).
zstd-max-c-level
(function).
zstd-min-c-level
(function).
zstd-out-buffer
(generic reader).
(setf zstd-out-buffer)
(generic writer).
zstd-out-buffer-tclass
(class).
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
.
Initialize the CONTEXT for the given compression LEVEL.
Recommended size for compression input buffer.
zstd
.
Recommended size for compression output buffer.
zstd
.
Set one compression parameter.
zstd
.
Compress the data with additional control on end directive.
zstd
.
Recommended size for decompression input buffer.
zstd
.
Recommended size for decompression output buffer.
zstd
.
Return a readable string from an error code.
zstd
.
zstd
.
decompressing-stream
)) ¶automatically generated reader method
zstd
.
decompressing-stream
)) ¶automatically generated writer method
zstd
.
decompressing-stream
)) ¶automatically generated reader method
compressing-stream
)) ¶automatically generated reader method
zstd
.
decompressing-stream
)) ¶automatically generated writer method
compressing-stream
)) ¶automatically generated writer method
zstd
.
decompressing-stream
)) ¶automatically generated reader method
zstd
.
decompressing-stream
)) ¶automatically generated writer method
zstd
.
decompressing-stream
)) ¶automatically generated reader method
compressing-stream
)) ¶automatically generated reader method
zstd
.
decompressing-stream
)) ¶automatically generated writer method
compressing-stream
)) ¶automatically generated writer method
zstd
.
compressing-stream
)) ¶automatically generated reader method
zstd
.
compressing-stream
)) ¶automatically generated writer method
zstd
.
decompressing-stream
)) ¶automatically generated reader method
compressing-stream
)) ¶automatically generated reader method
zstd
.
decompressing-stream
)) ¶automatically generated writer method
compressing-stream
)) ¶automatically generated writer method
zstd
.
decompressing-stream
)) ¶automatically generated reader method
compressing-stream
)) ¶automatically generated reader method
zstd
.
decompressing-stream
)) ¶automatically generated writer method
compressing-stream
)) ¶automatically generated writer method
zstd
.
decompressing-stream
)) ¶automatically generated reader method
compressing-stream
)) ¶automatically generated reader method
zstd
.
decompressing-stream
)) ¶automatically generated writer method
compressing-stream
)) ¶automatically generated writer method
zstd
.
fundamental-binary-output-stream
.
close
.
(setf input-buffer)
.
input-buffer
.
(setf output-buffer)
.
output-buffer
.
(setf output-stream)
.
output-stream
.
stream-element-type
.
stream-finish-output
.
stream-write-byte
.
stream-write-sequence
.
(setf zstd-context)
.
zstd-context
.
(setf zstd-in-buffer)
.
zstd-in-buffer
.
(setf zstd-out-buffer)
.
zstd-out-buffer
.
zstd
.
fundamental-binary-input-stream
.
close
.
(setf frame-complete-p)
.
frame-complete-p
.
(setf input-buffer)
.
input-buffer
.
(setf input-stream)
.
input-stream
.
(setf output-buffer)
.
output-buffer
.
stream-element-type
.
stream-listen
.
stream-read-byte
.
stream-read-sequence
.
(setf zstd-context)
.
zstd-context
.
(setf zstd-in-buffer)
.
zstd-in-buffer
.
(setf zstd-out-buffer)
.
zstd-out-buffer
.
zstd
.
foreign-struct-type
.
translatable-foreign-type
.
zstd
.
foreign-struct-type
.
translatable-foreign-type
.
Jump to: | (
C D F G I M O R S W Z |
---|
Jump to: | (
C D F G I M O R S W Z |
---|
Jump to: | +
C F I O S Z |
---|
Jump to: | +
C F I O S Z |
---|
Jump to: | C D F I L M P S T U Z |
---|
Jump to: | C D F I L M P S T U Z |
---|