The vellum-binary Reference Manual

3.1.1 vellum-binary/vellum-binary.asd

Source

vellum-binary.asd.

Parent Component

vellum-binary (system).

ASDF Systems

vellum-binary.

---

3.1.2 vellum-binary/package.lisp

Source

vellum-binary.asd.

Parent Component

vellum-binary (system).

Packages

vellum-binary.

---

3.1.3 vellum-binary/code.lisp

Dependency

package.lisp (file).

Source

vellum-binary.asd.

Parent Component

vellum-binary (system).

Public Interface

• make-compressing-stream (generic function).
• make-decompressing-stream (generic function).
• read-elements-callback (generic function).
• write-elements-callback (generic function).

Internals

• +version+ (constant).
• count-nodes (function).
• decode-string (function).
• dump-bitmasks (function).
• dump-column (function).
• encode-string (function).
• mask-signed (function).
• read-column (function).
• read-file-header (function).
• read-object (function).
• read-stream (function).
• restore-bitmasks (function).
• restore-column (function).
• write-column (function).
• write-file-header (function).
• write-object (function).
• write-stream (function).

---

5.1.1 Generic functions

Generic Function: make-compressing-stream (symbol output-stream) ¶

Package

vellum-binary.

Source

code.lisp.

Methods

Method: make-compressing-stream ((symbol (eql :gzip)) output-stream) ¶

Method: make-compressing-stream ((symbol (eql :zlib)) output-stream) ¶

Method: make-compressing-stream ((symbol (eql nil)) output-stream) ¶

Generic Function: make-decompressing-stream (symbol input-stream) ¶

Package

vellum-binary.

Source

code.lisp.

Methods

Method: make-decompressing-stream ((symbol (eql :gzip)) input-stream) ¶

Method: make-decompressing-stream ((symbol (eql :zlib)) input-stream) ¶

Method: make-decompressing-stream ((symbol (eql nil)) input-stream) ¶

Generic Function: read-elements-callback (column-type) ¶

Package

vellum-binary.

Source

code.lisp.

Methods

Method: read-elements-callback ((column-type (eql boolean))) ¶

Method: read-elements-callback ((column-type (eql fixnum))) ¶

Method: read-elements-callback (column-type) ¶

Generic Function: write-elements-callback (column-type) ¶

Package

vellum-binary.

Source

code.lisp.

Methods

Method: write-elements-callback ((column-type (eql boolean))) ¶

Method: write-elements-callback ((column-type (eql fixnum))) ¶

Method: write-elements-callback (column-type) ¶

---

5.2.1 Constants

Constant: +version+ ¶

Package

vellum-binary.

Source

code.lisp.

---

5.2.2 Ordinary functions

Function: count-nodes (column) ¶

Package

vellum-binary.

Source

code.lisp.

Function: decode-string (stream octets) ¶

Package

vellum-binary.

Source

code.lisp.

Function: dump-bitmasks (column stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: dump-column (column-type column stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: encode-string (string stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: mask-signed (x size) ¶

Package

vellum-binary.

Source

code.lisp.

Function: read-column (stream header index) ¶

Package

vellum-binary.

Source

code.lisp.

Function: read-file-header (stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: read-object (stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: read-stream (stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: restore-bitmasks (column stream shift nodes-count) ¶

Package

vellum-binary.

Source

code.lisp.

Function: restore-column (column-type column stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: write-column (column stream header index) ¶

Package

vellum-binary.

Source

code.lisp.

Function: write-file-header (stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: write-object (object stream) ¶

Package

vellum-binary.

Source

code.lisp.

Function: write-stream (table stream options) ¶

Package

vellum-binary.

Source

code.lisp.

---