The thnappy Reference Manual

This is the thnappy Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 15:04:52 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 thnappy

Common Lisp bindings to Google’s Snappy compression library.

Author

Markus Flambard <>

License

BSD License

Version

0.0.1

Dependency

cffi (system).

Source

thnappy.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 thnappy/src

Source

thnappy.asd.

Parent Component

thnappy (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 thnappy/thnappy.asd

Source

thnappy.asd.

Parent Component

thnappy (system).

ASDF Systems

thnappy.

Packages

thnappy-system.


4.1.2 thnappy/src/package.lisp

Source

thnappy.asd.

Parent Component

src (module).

Packages

thnappy.


4.1.3 thnappy/src/conditions.lisp

Dependency

package.lisp (file).

Source

thnappy.asd.

Parent Component

src (module).

Public Interface

4.1.4 thnappy/src/libsnappy.lisp

Dependency

package.lisp (file).

Source

thnappy.asd.

Parent Component

src (module).

Internals

4.1.5 thnappy/src/block-memory-operations.lisp

Dependency

package.lisp (file).

Source

thnappy.asd.

Parent Component

src (module).

Internals

4.1.6 thnappy/src/thnappy.lisp

Dependencies
Source

thnappy.asd.

Parent Component

src (module).

Public Interface
Internals

make-byte-vector (function).


5 Packages

Packages are listed by definition order.


5.1 thnappy-system

Source

thnappy.asd.

Use List

common-lisp.


5.2 thnappy

Common Lisp bindings to Google’s Snappy compression library.

Source

package.lisp.

Nickname

snappy

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Ordinary functions

Function: compress-byte-vector (bytes)
Package

thnappy.

Source

thnappy.lisp.

Function: compress-string (string)
Package

thnappy.

Source

thnappy.lisp.

Function: uncompress-byte-vector (compressed-bytes)
Package

thnappy.

Source

thnappy.lisp.

Function: valid-compressed-byte-vector-p (bytes)
Package

thnappy.

Source

thnappy.lisp.


6.1.2 Generic functions

Generic Function: compress (bytes)

Compresses BYTES and returns a vector.

Package

thnappy.

Source

thnappy.lisp.

Methods
Method: compress ((bytes sequence))
Method: compress ((bytes string))
Method: compress ((bytes vector))
Generic Function: uncompress (bytes &key to-string &allow-other-keys)

Uncompresses BYTES and returns a vector.

Package

thnappy.

Source

thnappy.lisp.

Methods
Method: uncompress ((bytes sequence) &key &allow-other-keys)
Method: uncompress ((bytes string) &key &allow-other-keys)
Method: uncompress ((bytes vector) &key &allow-other-keys)
Method: uncompress :around (bytes &key to-string)
Generic Function: valid-compressed-p (bytes)

Returns true if BYTES is a valid for uncompression.

Package

thnappy.

Source

thnappy.lisp.

Methods
Method: valid-compressed-p ((bytes sequence))
Method: valid-compressed-p ((bytes string))
Method: valid-compressed-p ((bytes vector))

6.1.3 Conditions

Condition: buffer-too-small

Snappy says that the buffer is too small.

Package

thnappy.

Source

conditions.lisp.

Direct superclasses

error.

Condition: invalid-input

Snappy says this is invalid input.

Package

thnappy.

Source

conditions.lisp.

Direct superclasses

error.


6.2 Internals


6.2.1 Ordinary functions

Function: make-byte-vector (size)
Package

thnappy.

Source

thnappy.lisp.

Function: mem-fill (ptr type count value &optional offset)
Package

thnappy.

Source

block-memory-operations.lisp.

Function: mem-read-c-string (string ptr &optional offset)
Package

thnappy.

Source

block-memory-operations.lisp.

Function: mem-read-vector (vector ptr type count &optional offset)
Package

thnappy.

Source

block-memory-operations.lisp.

Function: mem-write-c-string (string ptr &optional offset)
Package

thnappy.

Source

block-memory-operations.lisp.

Function: mem-write-vector (vector ptr type &optional count offset)
Package

thnappy.

Source

block-memory-operations.lisp.

Function: snappy-compress (input input-length compressed compressed-length)
Package

thnappy.

Source

libsnappy.lisp.

Function: snappy-max-compressed-length (source-length)
Package

thnappy.

Source

libsnappy.lisp.

Function: snappy-uncompress (compressed compressed-length uncompressed uncompressed-length)
Package

thnappy.

Source

libsnappy.lisp.

Function: snappy-uncompressed-length (compressed compressed-length result)
Package

thnappy.

Source

libsnappy.lisp.

Function: snappy-validate-compressed-buffer (compressed compressed-length)
Package

thnappy.

Source

libsnappy.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   F   G   M   S   U   V  
Index Entry  Section

C
compress: Public generic functions
compress: Public generic functions
compress: Public generic functions
compress: Public generic functions
compress-byte-vector: Public ordinary functions
compress-string: Public ordinary functions

F
Function, compress-byte-vector: Public ordinary functions
Function, compress-string: Public ordinary functions
Function, make-byte-vector: Private ordinary functions
Function, mem-fill: Private ordinary functions
Function, mem-read-c-string: Private ordinary functions
Function, mem-read-vector: Private ordinary functions
Function, mem-write-c-string: Private ordinary functions
Function, mem-write-vector: Private ordinary functions
Function, snappy-compress: Private ordinary functions
Function, snappy-max-compressed-length: Private ordinary functions
Function, snappy-uncompress: Private ordinary functions
Function, snappy-uncompressed-length: Private ordinary functions
Function, snappy-validate-compressed-buffer: Private ordinary functions
Function, uncompress-byte-vector: Public ordinary functions
Function, valid-compressed-byte-vector-p: Public ordinary functions

G
Generic Function, compress: Public generic functions
Generic Function, uncompress: Public generic functions
Generic Function, valid-compressed-p: Public generic functions

M
make-byte-vector: Private ordinary functions
mem-fill: Private ordinary functions
mem-read-c-string: Private ordinary functions
mem-read-vector: Private ordinary functions
mem-write-c-string: Private ordinary functions
mem-write-vector: Private ordinary functions
Method, compress: Public generic functions
Method, compress: Public generic functions
Method, compress: Public generic functions
Method, uncompress: Public generic functions
Method, uncompress: Public generic functions
Method, uncompress: Public generic functions
Method, uncompress: Public generic functions
Method, valid-compressed-p: Public generic functions
Method, valid-compressed-p: Public generic functions
Method, valid-compressed-p: Public generic functions

S
snappy-compress: Private ordinary functions
snappy-max-compressed-length: Private ordinary functions
snappy-uncompress: Private ordinary functions
snappy-uncompressed-length: Private ordinary functions
snappy-validate-compressed-buffer: Private ordinary functions

U
uncompress: Public generic functions
uncompress: Public generic functions
uncompress: Public generic functions
uncompress: Public generic functions
uncompress: Public generic functions
uncompress-byte-vector: Public ordinary functions

V
valid-compressed-byte-vector-p: Public ordinary functions
valid-compressed-p: Public generic functions
valid-compressed-p: Public generic functions
valid-compressed-p: Public generic functions
valid-compressed-p: Public generic functions


A.3 Variables