Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the hu.dwim.zlib Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 13:36:13 2021 GMT+0.
• Introduction | What hu.dwim.zlib is all about | |
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
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: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The hu.dwim.zlib system |
Attila Lendvai
BSD or Bugroff
Common Lisp FFI wrapper for zlib, aka http://zlib.net/
0.1
cffi/c2ffi
hu.dwim.zlib.asd (file)
Modules are listed depth-first from the system components tree.
• The hu.dwim.zlib/source module | ||
• The hu.dwim.zlib/c2ffi-spec module |
Next: The hu․dwim․zlib/c2ffi-spec module, Previous: Modules, Up: Modules [Contents][Index]
hu.dwim.zlib (system)
source/
Previous: The hu․dwim․zlib/source module, Up: Modules [Contents][Index]
package-stage-1.lisp (file)
hu.dwim.zlib (system)
c2ffi-spec/
zlib.h (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The hu․dwim․zlib/package-stage-1․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
hu.dwim.zlib.asd
hu.dwim.zlib (system)
Next: The hu․dwim․zlib/source/package-stage-2․lisp file, Previous: The hu․dwim․zlib․asd file, Up: Lisp files [Contents][Index]
hu.dwim.zlib (system)
source/package-stage-1.lisp
Next: The hu․dwim․zlib/source/package-stage-3․lisp file, Previous: The hu․dwim․zlib/package-stage-1․lisp file, Up: Lisp files [Contents][Index]
source (module)
source/package-stage-2.lisp
import-all-owned-symbols (function)
Next: The hu․dwim․zlib/source/zlib․lisp file, Previous: The hu․dwim․zlib/source/package-stage-2․lisp file, Up: Lisp files [Contents][Index]
package-stage-2.lisp (file)
source (module)
source/package-stage-3.lisp
Next: The hu․dwim․zlib/c2ffi-spec/zlib․h file, Previous: The hu․dwim․zlib/source/package-stage-3․lisp file, Up: Lisp files [Contents][Index]
package-stage-3.lisp (file)
source (module)
source/zlib.lisp
Previous: The hu․dwim․zlib/source/zlib․lisp file, Up: Lisp files [Contents][Index]
c2ffi-spec (module)
c2ffi-spec/zlib.h
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The hu.dwim.zlib package |
package-stage-1.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported constants | ||
• Exported macros | ||
• Exported functions |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
zlib.lisp (file)
Next: Exported functions, Previous: Exported constants, Up: Exported definitions [Contents][Index]
zlib.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
zlib.lisp (file)
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.
zlib.lisp (file)
See DEFLATE-SEQUENCE for usage.
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
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).
zlib.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal macros | ||
• Internal functions | ||
• Internal types |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
zlib.lisp (file)
Next: Internal functions, Previous: Internal constants, Up: Internal definitions [Contents][Index]
zlib.lisp (file)
zlib.lisp (file)
Next: Internal types, Previous: Internal macros, Up: Internal definitions [Contents][Index]
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
package-stage-2.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
zlib.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F H L M |
---|
Jump to: | F H L M |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
A C D F I M S U |
---|
Jump to: | %
A C D F I M S U |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | +
C |
---|
Jump to: | +
C |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C H O P S T U W |
---|
Jump to: | C H O P S T U W |
---|