The vellum-binary Reference Manual

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

The vellum-binary Reference Manual

This is the vellum-binary Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 07:32:05 2022 GMT+0.

Table of Contents


1 Introduction

vellum-binary

A custom, binary, file format for VELLUM library.

Uses cl-conspack, chipz, salza2.

Example

(vellum:copy-to :binary "~/path.vel" *dataframe* :compression :zlib)
(vellum:copy-to :binary "~/path.vel" *dataframe* :compression :gzip)
(vellum:copy-to :binary "~/path.vel" *dataframe*)
(defparameter *dataframe* (vellum:copy-from :binary "~/path.vel"))

Instead of file path you can also pass octet output-stream.

Provides WRITE-ELEMENTS-CALLBACK and READ-ELEMENTS-CALLBACK generic functions for programmer to implement custom serialization and deserialization for objects of a given type to streams. Type is taken from column-type. Implements handling for boolean, fixnum, single-float, double-float. Everything else is handled by cl-conspack library.

In addition to the built-in chipz/salza2 compression you can use compression algorithms of your choosing by specializing make-compressing-stream and make-decompressing-stream generic functions. It is probably preffered to use a quick compression, CL-ZSTD perhaps would be nice.

NOTE Implementing WRITE-ELEMENTS-CALLBACK may result with files that cannot be read without loading additional READ-ELEMENTS-CALLBACK. Therefore it is adviced for you to abstain from doing so, unless needed.


2 Systems

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


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

2.1 vellum-binary

vellum custom binary format.

Author

Marek Kochanowicz

License

BSD simplified

Version

1.0.0

Dependencies
  • vellum (system)., at least version ((>= "1.3.0"))
  • chipz (system).
  • salza2 (system).
  • nibbles (system).
  • ieee-floats (system).
  • cl-conspack (system).
Source

vellum-binary.asd.

Child Components

3 Files

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


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

3.1 Lisp


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

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
Internals

4 Packages

Packages are listed by definition order.


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

4.1 vellum-binary

Source

package.lisp.

Use List
  • common-lisp.
  • vellum.aux-package.
Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


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 Internals


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

5.2.1 Constants

Constant: +version+
Package

vellum-binary.

Source

code.lisp.


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

5.2.2 Ordinary functions

Function: count-nodes (column)
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: 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.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   C   D   F   G   M   R   W  
Index Entry  Section

C
count-nodes: Private ordinary functions

D
dump-bitmasks: Private ordinary functions
dump-column: Private ordinary functions

F
Function, count-nodes: Private ordinary functions
Function, dump-bitmasks: Private ordinary functions
Function, dump-column: Private ordinary functions
Function, mask-signed: Private ordinary functions
Function, read-column: Private ordinary functions
Function, read-file-header: Private ordinary functions
Function, read-object: Private ordinary functions
Function, read-stream: Private ordinary functions
Function, restore-bitmasks: Private ordinary functions
Function, restore-column: Private ordinary functions
Function, write-column: Private ordinary functions
Function, write-file-header: Private ordinary functions
Function, write-object: Private ordinary functions
Function, write-stream: Private ordinary functions

G
Generic Function, make-compressing-stream: Public generic functions
Generic Function, make-decompressing-stream: Public generic functions
Generic Function, read-elements-callback: Public generic functions
Generic Function, write-elements-callback: Public generic functions

M
make-compressing-stream: Public generic functions
make-compressing-stream: Public generic functions
make-compressing-stream: Public generic functions
make-compressing-stream: Public generic functions
make-decompressing-stream: Public generic functions
make-decompressing-stream: Public generic functions
make-decompressing-stream: Public generic functions
make-decompressing-stream: Public generic functions
mask-signed: Private ordinary functions
Method, make-compressing-stream: Public generic functions
Method, make-compressing-stream: Public generic functions
Method, make-compressing-stream: Public generic functions
Method, make-decompressing-stream: Public generic functions
Method, make-decompressing-stream: Public generic functions
Method, make-decompressing-stream: Public generic functions
Method, read-elements-callback: Public generic functions
Method, read-elements-callback: Public generic functions
Method, read-elements-callback: Public generic functions
Method, write-elements-callback: Public generic functions
Method, write-elements-callback: Public generic functions
Method, write-elements-callback: Public generic functions

R
read-column: Private ordinary functions
read-elements-callback: Public generic functions
read-elements-callback: Public generic functions
read-elements-callback: Public generic functions
read-elements-callback: Public generic functions
read-file-header: Private ordinary functions
read-object: Private ordinary functions
read-stream: Private ordinary functions
restore-bitmasks: Private ordinary functions
restore-column: Private ordinary functions

W
write-column: Private ordinary functions
write-elements-callback: Public generic functions
write-elements-callback: Public generic functions
write-elements-callback: Public generic functions
write-elements-callback: Public generic functions
write-file-header: Private ordinary functions
write-object: Private ordinary functions
write-stream: Private ordinary functions

Jump to:   C   D   F   G   M   R   W  

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

A.3 Variables

Jump to:   +  
C  
Index Entry  Section

+
+version+: Private constants

C
Constant, +version+: Private constants

Jump to:   +  
C