The thnappy Reference Manual

Table of Contents

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

The thnappy Reference Manual

This is the thnappy Reference Manual, version 0.0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:25:20 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

thnappy

Common Lisp bindings to Google's Snappy compression library.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

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)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


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

3.1 thnappy/src

Parent

thnappy (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


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

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 thnappy.asd

Location

thnappy.asd

Systems

thnappy (system)

Packages

thnappy-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 thnappy/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

thnappy


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 thnappy/src/conditions.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/conditions.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 thnappy/src/libsnappy.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/libsnappy.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

package.lisp (file)

Parent

src (module)

Location

src/block-memory-operations.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.6 thnappy/src/thnappy.lisp

Dependencies
Parent

src (module)

Location

src/thnappy.lisp

Exported Definitions
Internal Definitions

make-byte-vector (function)


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


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

5.1 thnappy-system

Source

thnappy.asd

Use List

common-lisp


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

5.2 thnappy

Common Lisp bindings to Google’s Snappy compression library.

Source

package.lisp (file)

Nickname

snappy

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)

Previous: , Up: Exported definitions   [Contents][Index]

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)


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

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   T  
Index Entry  Section

F
File, Lisp, thnappy.asd: The thnappy<dot>asd file
File, Lisp, thnappy/src/block-memory-operations.lisp: The thnappy/src/block-memory-operations<dot>lisp file
File, Lisp, thnappy/src/conditions.lisp: The thnappy/src/conditions<dot>lisp file
File, Lisp, thnappy/src/libsnappy.lisp: The thnappy/src/libsnappy<dot>lisp file
File, Lisp, thnappy/src/package.lisp: The thnappy/src/package<dot>lisp file
File, Lisp, thnappy/src/thnappy.lisp: The thnappy/src/thnappy<dot>lisp file

L
Lisp File, thnappy.asd: The thnappy<dot>asd file
Lisp File, thnappy/src/block-memory-operations.lisp: The thnappy/src/block-memory-operations<dot>lisp file
Lisp File, thnappy/src/conditions.lisp: The thnappy/src/conditions<dot>lisp file
Lisp File, thnappy/src/libsnappy.lisp: The thnappy/src/libsnappy<dot>lisp file
Lisp File, thnappy/src/package.lisp: The thnappy/src/package<dot>lisp file
Lisp File, thnappy/src/thnappy.lisp: The thnappy/src/thnappy<dot>lisp file

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

T
thnappy.asd: The thnappy<dot>asd file
thnappy/src: The thnappy/src module
thnappy/src/block-memory-operations.lisp: The thnappy/src/block-memory-operations<dot>lisp file
thnappy/src/conditions.lisp: The thnappy/src/conditions<dot>lisp file
thnappy/src/libsnappy.lisp: The thnappy/src/libsnappy<dot>lisp file
thnappy/src/package.lisp: The thnappy/src/package<dot>lisp file
thnappy/src/thnappy.lisp: The thnappy/src/thnappy<dot>lisp file

Jump to:   F   L   M   T  

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

A.2 Functions

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

C
compress: Exported generic functions
compress: Exported generic functions
compress: Exported generic functions
compress: Exported generic functions
compress-byte-vector: Exported functions
compress-string: Exported functions

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

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

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

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

U
uncompress: Exported generic functions
uncompress: Exported generic functions
uncompress: Exported generic functions
uncompress: Exported generic functions
uncompress: Exported generic functions
uncompress-byte-vector: Exported functions

V
valid-compressed-byte-vector-p: Exported functions
valid-compressed-p: Exported generic functions
valid-compressed-p: Exported generic functions
valid-compressed-p: Exported generic functions
valid-compressed-p: Exported generic functions

Jump to:   C   F   G   M   S   U   V  

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

A.3 Variables


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

A.4 Data types

Jump to:   B   C   I   P   S   T  
Index Entry  Section

B
buffer-too-small: Exported conditions

C
Condition, buffer-too-small: Exported conditions
Condition, invalid-input: Exported conditions

I
invalid-input: Exported conditions

P
Package, thnappy: The thnappy package
Package, thnappy-system: The thnappy-system package

S
System, thnappy: The thnappy system

T
thnappy: The thnappy system
thnappy: The thnappy package
thnappy-system: The thnappy-system package

Jump to:   B   C   I   P   S   T