The thnappy Reference Manual

Table of Contents

The thnappy Reference Manual

This is the thnappy Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 15:28:35 2020 GMT+0.

1 Introduction

thnappy

Common Lisp bindings to Google's Snappy compression library.

2 Systems

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

2.1 thnappy

Author

Markus Flambard <mflambard@common-lisp.net>

License

BSD License

Description

Common Lisp bindings to Google’s Snappy compression library.

Version

0.0.1

Dependency

cffi

Source

thnappy.asd (file)

Component

src (module)

3 Modules

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

3.1 thnappy/src

Parent

thnappy (system)

Location

src/

Components

• package.lisp (file)
• conditions.lisp (file)
• libsnappy.lisp (file)
• block-memory-operations.lisp (file)
• thnappy.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 thnappy.asd

Location

thnappy.asd

Systems

thnappy (system)

Packages

thnappy-system

4.1.2 thnappy/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

thnappy

4.1.3 thnappy/src/conditions.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/conditions.lisp

Exported Definitions

• buffer-too-small (condition)
• invalid-input (condition)

4.1.4 thnappy/src/libsnappy.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/libsnappy.lisp

Internal Definitions

• snappy-compress (function)
• snappy-max-compressed-length (function)
• snappy-uncompress (function)
• snappy-uncompressed-length (function)
• snappy-validate-compressed-buffer (function)

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

Dependency

package.lisp (file)

Parent

src (module)

Location

src/block-memory-operations.lisp

Internal Definitions

• mem-fill (function)
• mem-read-c-string (function)
• mem-read-vector (function)
• mem-write-c-string (function)
• mem-write-vector (function)

4.1.6 thnappy/src/thnappy.lisp

Dependencies

• libsnappy.lisp (file)
• block-memory-operations.lisp (file)

Parent

src (module)

Location

src/thnappy.lisp

Exported Definitions

• compress (generic function)
• compress (method)
• compress (method)
• compress (method)
• compress-byte-vector (function)
• compress-string (function)
• uncompress (generic function)
• uncompress (method)
• uncompress (method)
• uncompress (method)
• uncompress (method)
• uncompress-byte-vector (function)
• valid-compressed-byte-vector-p (function)
• valid-compressed-p (generic function)
• valid-compressed-p (method)
• valid-compressed-p (method)
• valid-compressed-p (method)

Internal Definitions

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 (file)

Nickname

snappy

Use List

• cffi
• common-lisp

Exported Definitions

• buffer-too-small (condition)
• compress (generic function)
• compress (method)
• compress (method)
• compress (method)
• compress-byte-vector (function)
• compress-string (function)
• invalid-input (condition)
• uncompress (generic function)
• uncompress (method)
• uncompress (method)
• uncompress (method)
• uncompress (method)
• uncompress-byte-vector (function)
• valid-compressed-byte-vector-p (function)
• valid-compressed-p (generic function)
• valid-compressed-p (method)
• valid-compressed-p (method)
• valid-compressed-p (method)

Internal Definitions

• make-byte-vector (function)
• mem-fill (function)
• mem-read-c-string (function)
• mem-read-vector (function)
• mem-write-c-string (function)
• mem-write-vector (function)
• snappy-compress (function)
• snappy-max-compressed-length (function)
• snappy-uncompress (function)
• snappy-uncompressed-length (function)
• snappy-validate-compressed-buffer (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: compress-byte-vector BYTES

Package

thnappy

Source

thnappy.lisp (file)

Function: compress-string STRING

Package

thnappy

Source

thnappy.lisp (file)

Function: uncompress-byte-vector COMPRESSED-BYTES

Package

thnappy

Source

thnappy.lisp (file)

Function: valid-compressed-byte-vector-p BYTES

Package

thnappy

Source

thnappy.lisp (file)

6.1.2 Generic functions

Generic Function: compress BYTES

Compresses BYTES and returns a vector.

Package

thnappy

Source

thnappy.lisp (file)

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 (file)

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 BYTES &key TO-STRING around

Generic Function: valid-compressed-p BYTES

Returns true if BYTES is a valid for uncompression.

Package

thnappy

Source

thnappy.lisp (file)

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 (file)

Direct superclasses

error (condition)

Condition: invalid-input ()

Snappy says this is invalid input.

Package

thnappy

Source

conditions.lisp (file)

Direct superclasses

error (condition)

6.2 Internal definitions

6.2.1 Functions

Function: make-byte-vector SIZE

Package

thnappy

Source

thnappy.lisp (file)

Function: mem-fill PTR TYPE COUNT VALUE &optional OFFSET

Package

thnappy

Source

block-memory-operations.lisp (file)

Function: mem-read-c-string STRING PTR &optional OFFSET

Package

thnappy

Source

block-memory-operations.lisp (file)

Function: mem-read-vector VECTOR PTR TYPE COUNT &optional OFFSET

Package

thnappy

Source

block-memory-operations.lisp (file)

Function: mem-write-c-string STRING PTR &optional OFFSET

Package

thnappy

Source

block-memory-operations.lisp (file)

Function: mem-write-vector VECTOR PTR TYPE &optional COUNT OFFSET

Package

thnappy

Source

block-memory-operations.lisp (file)

Function: snappy-compress INPUT INPUT-LENGTH COMPRESSED COMPRESSED-LENGTH

Package

thnappy

Source

libsnappy.lisp (file)

Function: snappy-max-compressed-length SOURCE-LENGTH

Package

thnappy

Source

libsnappy.lisp (file)

Function: snappy-uncompress COMPRESSED COMPRESSED-LENGTH UNCOMPRESSED UNCOMPRESSED-LENGTH

Package

thnappy

Source

libsnappy.lisp (file)

Function: snappy-uncompressed-length COMPRESSED COMPRESSED-LENGTH RESULT

Package

thnappy

Source

libsnappy.lisp (file)

Function: snappy-validate-compressed-buffer COMPRESSED COMPRESSED-LENGTH

Package

thnappy

Source

libsnappy.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types