Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the hu.dwim.zlib Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 04:48:34 2022 GMT+0.
Next: Systems, Previous: The hu.dwim.zlib Reference Manual, Up: The hu.dwim.zlib Reference Manual [Contents][Index]
A Common Lisp FFI for zlib (which is a compression library for deflate and gzip written in C).
It uses CFFI/C2FFI to automatically generate the CFFI definitions, so it's a complete interface based on the C header files.
zlib's gzip format can be used for compressing HTTP responses to browsers.
Written by attila@lendvai.name.
The primary communication channel is the facilities on the project's GitHub page.
The raw FFI part is almost complete (except some va_list stuff).
No fancy lispy overlay API has been added; it seems to be convenient enough without it.
It's used in hu.dwim.web-server to compress HTTP responses.
It has a test that compresses and decompresses random data in random zlib configurations, and it doesn't yield any errors for me when run for minutes (besides some zlib peculiarities/bugs that are avoided by the test code).
Next: Modules, Previous: Introduction, Up: The hu.dwim.zlib Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Common Lisp FFI wrapper for zlib, aka http://zlib.net/
Attila Lendvai
BSD or Bugroff
0.1
cffi/c2ffi (system).
Next: Files, Previous: Systems, Up: The hu.dwim.zlib Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
Next: hu.dwim.zlib/c2ffi-spec, Previous: Modules, Up: Modules [Contents][Index]
hu.dwim.zlib (system).
Previous: hu.dwim.zlib/source, Up: Modules [Contents][Index]
package-stage-1.lisp (file).
hu.dwim.zlib (system).
zlib.h (file).
Next: Packages, Previous: Modules, Up: The hu.dwim.zlib Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: hu.dwim.zlib/package-stage-1.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
hu.dwim.zlib (system).
Next: hu.dwim.zlib/source/package-stage-2.lisp, Previous: hu.dwim.zlib/hu.dwim.zlib.asd, Up: Lisp [Contents][Index]
hu.dwim.zlib (system).
Next: hu.dwim.zlib/source/package-stage-3.lisp, Previous: hu.dwim.zlib/package-stage-1.lisp, Up: Lisp [Contents][Index]
source (module).
import-all-owned-symbols (function).
Next: hu.dwim.zlib/source/zlib.lisp, Previous: hu.dwim.zlib/source/package-stage-2.lisp, Up: Lisp [Contents][Index]
package-stage-2.lisp (file).
source (module).
Next: hu.dwim.zlib/c2ffi-spec/zlib.h, Previous: hu.dwim.zlib/source/package-stage-3.lisp, Up: Lisp [Contents][Index]
package-stage-3.lisp (file).
source (module).
Previous: hu.dwim.zlib/source/zlib.lisp, Up: Lisp [Contents][Index]
c2ffi-spec (module).
Next: Definitions, Previous: Files, Up: The hu.dwim.zlib Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: Indexes, Previous: Packages, Up: The hu.dwim.zlib Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
Next: Ordinary functions, Previous: Constants, Up: Public Interface [Contents][Index]
Previous: Macros, Up: Public Interface [Contents][Index]
A simpler API for the stream based DEFLATE.
Compress the first SOURCE-START bytes of SOURCE into DESTINATION. DESTINATION should be an array of (unsigned-byte 8), and should be large enough to hold the compressed contents. ALLOCATE-COMPRESS-BUFFER can be used to allocate a proper buffer.
Note that the size of the DESTINATION array should be at least 0.1% more than the souce plus 12 bytes, but the actual number of array elements filled in by the compression algorithm will usually be smaller (depending on how ’predictable’ the input data is).
Returns DESTINATION-END i.e. compressed length if DESTINATION-START was zero.
See DEFLATE-SEQUENCE for usage.
A simpler API for the stream based INFLATE.
Pretty useless because DESTINATION must be long enough to hold the uncompressed contents, otherwise it errors out. Returns (values destination-end).
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Constants, Up: Internals [Contents][Index]
Previous: Definitions, Up: The hu.dwim.zlib Reference Manual [Contents][Index]
| Jump to: | %
A C D F I M S U |
|---|
| Jump to: | %
A C D F I M S U |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | +
C |
|---|
| Jump to: | +
C |
|---|
| Jump to: | C F H M O P S T U W Z |
|---|
| Jump to: | C F H M O P S T U W Z |
|---|