BERT reference

Version 0.1.0.

This is the reference document for BERT, which is part of CLERIC (Common Lisp Erlang Interface). It describes all symbols exported from the BERT package.

The latest version of this document is available here: http://common-lisp.net/project/cleric/doc/bert_reference.html

The BERT package: Classes; Functions; Variables; Conditions

The BERT package

CLERIC implements the BERT binary data interchange format and exports these functions through the BERT package.

Classes

[Standard class]
bert-regex

Represents a BERT regex term.

[Standard class]
bert-time

Represents a BERT time term.

[Standard class]
erlang-binary

Inherited from CLERIC. See cleric:erlang-binary .

[Standard class]
erlang-tuple

Inherited from CLERIC. See cleric:erlang-tuple .

Functions

[Generic function]
arity tuple => size

Inherited from CLERIC. See cleric:arity.

[Function]
binary &rest bytes => binary

Inherited from CLERIC. See cleric:binary .

[Function]
binary-to-string binary => string

Inherited from CLERIC. See cleric:binary-to-string.

[Function]
bool value => bert-boolean

Returns the value of bert:true if value is true, otherwise returns the value of bert:false.

[Generic function]
bytes binary => bytes

Inherited from CLERIC. See cleric:bytes.

[Function]
bytes-to-binary bytes => binary

Inherited from CLERIC. See cleric:bytes-to-binary .

[Function]
decode bytes => bert-term, position

Decodes the sequence bytes into BERT terms. position is the number of bytes consumed from bytes.

[Generic function]
elements tuple => vector

Inherited from CLERIC. See cleric:elements .

[Generic function]
encode object &key berp-header => bytes

berp-header defaults to NIL.

Encodes object according to BERT into a vector of bytes. If berp-header is true the resulting byte vector is prepended with a BERP header, a four byte length header.

[Generic function]
size tuple-or-binary => size