Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

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 May 15 06:37:36 2023 GMT+0.

Next: Systems, Previous: The thnappy Reference Manual, Up: The thnappy Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The thnappy Reference Manual [Contents][Index]

2 Systems

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

thnappy

Previous: Systems, Up: Systems [Contents][Index]

2.1 `thnappy`

Common Lisp bindings to Google’s Snappy compression library.

Author: Markus Flambard <mflambard@common-lisp.net>
License: BSD License
Version: 0.0.1
Dependency: cffi (system).
Source: thnappy.asd.
Child Component: src (module).

Next: Files, Previous: Systems, Up: The thnappy Reference Manual [Contents][Index]

3 Modules

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

thnappy/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `thnappy/src`

Source

thnappy.asd.

Parent Component

thnappy (system).

Child Components

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

Next: Packages, Previous: Modules, Up: The thnappy Reference Manual [Contents][Index]

4 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

4.1 Lisp

thnappy/thnappy.asd
thnappy/src/package.lisp
thnappy/src/conditions.lisp
thnappy/src/libsnappy.lisp
thnappy/src/block-memory-operations.lisp
thnappy/src/thnappy.lisp

Next: thnappy/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `thnappy/thnappy.asd`

Source: thnappy.asd.
Parent Component: thnappy (system).
ASDF Systems: thnappy.
Packages: thnappy-system.

Next: thnappy/src/conditions.lisp, Previous: thnappy/thnappy.asd, Up: Lisp [Contents][Index]

4.1.2 `thnappy/src/package.lisp`

Source: thnappy.asd.
Parent Component: src (module).
Packages: thnappy.

Next: thnappy/src/libsnappy.lisp, Previous: thnappy/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `thnappy/src/conditions.lisp`

Dependency

package.lisp (file).

Source

thnappy.asd.

Parent Component

src (module).

Public Interface

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

Next: thnappy/src/block-memory-operations.lisp, Previous: thnappy/src/conditions.lisp, Up: Lisp [Contents][Index]

4.1.4 `thnappy/src/libsnappy.lisp`

Dependency

package.lisp (file).

Source

thnappy.asd.

Parent Component

src (module).

Internals

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

Next: thnappy/src/thnappy.lisp, Previous: thnappy/src/libsnappy.lisp, Up: Lisp [Contents][Index]

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

Dependency

package.lisp (file).

Source

thnappy.asd.

Parent Component

src (module).

Internals

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

Previous: thnappy/src/block-memory-operations.lisp, Up: Lisp [Contents][Index]

4.1.6 `thnappy/src/thnappy.lisp`

Dependencies

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

Source

thnappy.asd.

Parent Component

src (module).

Public Interface

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

Internals

make-byte-vector (function).

Next: Definitions, Previous: Files, Up: The thnappy Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

thnappy-system
thnappy

Next: thnappy, Previous: Packages, Up: Packages [Contents][Index]

5.1 `thnappy-system`

Source: thnappy.asd.
Use List: common-lisp.

Previous: thnappy-system, Up: Packages [Contents][Index]

5.2 `thnappy`

Common Lisp bindings to Google’s Snappy compression library.

Source

package.lisp.

Nickname

snappy

Use List

cffi.
common-lisp.

Public Interface

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

Internals

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).

Next: Indexes, Previous: Packages, Up: The thnappy Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

Next: Conditions, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

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)) ¶

Previous: Generic functions, Up: Public Interface [Contents][Index]

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.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The thnappy Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	B C F I L M P S T

	Index Entry	Section

B
	`block-memory-operations.lisp`:	The thnappy/src/block-memory-operations․lisp file
	`buffer-too-small`:	Public conditions

C
	`Condition, buffer-too-small`:	Public conditions
	`Condition, invalid-input`:	Public conditions
	`conditions.lisp`:	The thnappy/src/conditions․lisp file

F
	`File, block-memory-operations.lisp`:	The thnappy/src/block-memory-operations․lisp file
	`File, conditions.lisp`:	The thnappy/src/conditions․lisp file
	`File, libsnappy.lisp`:	The thnappy/src/libsnappy․lisp file
	`File, package.lisp`:	The thnappy/src/package․lisp file
	`File, thnappy.asd`:	The thnappy/thnappy․asd file
	`File, thnappy.lisp`:	The thnappy/src/thnappy․lisp file

I
	`invalid-input`:	Public conditions

L
	`libsnappy.lisp`:	The thnappy/src/libsnappy․lisp file

M
	`Module, src`:	The thnappy/src module

P
	`Package, thnappy`:	The thnappy package
	`Package, thnappy-system`:	The thnappy-system package
	`package.lisp`:	The thnappy/src/package․lisp file

S
	`src`:	The thnappy/src module
	`System, thnappy`:	The thnappy system

T
	`thnappy`:	The thnappy system
	`thnappy`:	The thnappy package
	`thnappy-system`:	The thnappy-system package
	`thnappy.asd`:	The thnappy/thnappy․asd file
	`thnappy.lisp`:	The thnappy/src/thnappy․lisp file

The thnappy Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 thnappy

3 Modules

3.1 thnappy/src

4 Files

4.1 Lisp

4.1.1 thnappy/thnappy.asd

4.1.2 thnappy/src/package.lisp

4.1.3 thnappy/src/conditions.lisp

4.1.4 thnappy/src/libsnappy.lisp

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

4.1.6 thnappy/src/thnappy.lisp

5 Packages

5.1 thnappy-system

5.2 thnappy

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.1.2 Generic functions

6.1.3 Conditions

6.2 Internals

6.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `thnappy`

3.1 `thnappy/src`

4.1.1 `thnappy/thnappy.asd`

4.1.2 `thnappy/src/package.lisp`

4.1.3 `thnappy/src/conditions.lisp`

4.1.4 `thnappy/src/libsnappy.lisp`

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

4.1.6 `thnappy/src/thnappy.lisp`

5.1 `thnappy-system`

5.2 `thnappy`