The bert Reference Manual
This is the bert Reference Manual, version 0.2.1,
generated automatically by Declt version 4.0 beta 2 "William Riker"
on Sun Dec 15 04:41:24 2024 GMT+0.
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 bert
BERT serializer.
- Author
Markus Flambard <mflambard@common-lisp.net>
- License
MIT License
- Version
0.2.1
- Dependencies
erlang-term
(system)., at least version "0.2.0"
alexandria
(system).
- Source
bert.asd
.
- Child Component
src
(module).
3 Modules
Modules are listed depth-first from the system components tree.
3.1 bert/src
- Source
bert.asd
.
- Parent Component
bert
(system).
- Child Components
-
4 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
4.1 Lisp
4.1.2 bert/src/packages.lisp
- Source
bert.asd
.
- Parent Component
src
(module).
- Packages
bert
.
4.1.3 bert/src/bert.lisp
- Dependency
packages.lisp
(file).
- Source
bert.asd
.
- Parent Component
src
(module).
- Public Interface
-
- Internals
-
5 Packages
Packages are listed by definition order.
5.1 bert
BERT (Binary ERlang Term).
- Source
packages.lisp
.
- Use List
alexandria
.
common-lisp
.
erlang-term
.
etf-bops
.
- Public Interface
-
- Internals
-
5.2 bert-system
- Source
bert.asd
.
- Use List
common-lisp
.
6 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
6.1 Public Interface
6.1.1 Constants
- Constant: false ¶
-
BERT boolean false term.
- Package
bert
.
- Source
bert.lisp
.
- Constant: true ¶
-
BERT boolean true term.
- Package
bert
.
- Source
bert.lisp
.
6.1.2 Ordinary functions
- Function: bool (value) ¶
-
- Package
bert
.
- Source
bert.lisp
.
- Function: decode (bytes) ¶
-
- Package
bert
.
- Source
bert.lisp
.
6.1.3 Generic functions
- Generic Function: encode (object &key berp-header) ¶
-
Encodes the BERT-translatable object to a vector of bytes.
- Package
bert
.
- Source
bert.lisp
.
- Methods
- Method: encode (object &key berp-header) ¶
-
6.1.4 Classes
- Class: bert-regex ¶
-
BERT regex data type
- Package
bert
.
- Source
bert.lisp
.
- Direct methods
-
- Direct slots
- Slot: source ¶
-
- Initargs
:source
- Readers
regex-source
.
- Writers
This slot is read-only.
- Slot: options ¶
-
- Initargs
:options
- Readers
regex-options
.
- Writers
This slot is read-only.
- Class: bert-time ¶
-
BERT time data type
- Package
bert
.
- Source
bert.lisp
.
- Direct methods
-
- Direct slots
- Slot: megaseconds ¶
-
- Initargs
:megaseconds
- Readers
megaseconds
.
- Writers
This slot is read-only.
- Slot: seconds ¶
-
- Initargs
:seconds
- Readers
seconds
.
- Writers
This slot is read-only.
- Slot: microseconds ¶
-
- Initargs
:microseconds
- Readers
microseconds
.
- Writers
This slot is read-only.
6.2 Internals
6.2.1 Ordinary functions
- Function: bert-translatable-p (object) ¶
-
Returns true if OBJECT is translatable to an Erlang object.
- Package
bert
.
- Source
bert.lisp
.
- Function: complex-bert-term-p (bert-term) ¶
-
- Package
bert
.
- Source
bert.lisp
.
- Function: compound-bert-term-p (bert-term) ¶
-
- Package
bert
.
- Source
bert.lisp
.
- Function: simple-bert-term-p (bert-term) ¶
-
- Package
bert
.
- Source
bert.lisp
.
- Function: translate-complex-term (term) ¶
-
- Package
bert
.
- Source
bert.lisp
.
- Function: translate-complex-terms (term) ¶
-
- Package
bert
.
- Source
bert.lisp
.
- Function: translate-dict-term (dict) ¶
-
- Package
bert
.
- Source
bert.lisp
.
- Function: translate-regex-term (source options) ¶
-
- Package
bert
.
- Source
bert.lisp
.
- Function: translate-time-term (megaseconds seconds microseconds) ¶
-
- Package
bert
.
- Source
bert.lisp
.
6.2.2 Generic functions
- Generic Reader: megaseconds (object) ¶
-
- Package
bert
.
- Methods
- Reader Method: megaseconds ((bert-time
bert-time
)) ¶
-
automatically generated reader method
- Source
bert.lisp
.
- Target Slot
megaseconds
.
- Generic Reader: microseconds (object) ¶
-
- Package
bert
.
- Methods
- Reader Method: microseconds ((bert-time
bert-time
)) ¶
-
automatically generated reader method
- Source
bert.lisp
.
- Target Slot
microseconds
.
- Generic Reader: regex-options (object) ¶
-
- Package
bert
.
- Methods
- Reader Method: regex-options ((bert-regex
bert-regex
)) ¶
-
automatically generated reader method
- Source
bert.lisp
.
- Target Slot
options
.
- Generic Reader: regex-source (object) ¶
-
- Package
bert
.
- Methods
- Reader Method: regex-source ((bert-regex
bert-regex
)) ¶
-
automatically generated reader method
- Source
bert.lisp
.
- Target Slot
source
.
- Generic Reader: seconds (object) ¶
-
- Package
bert
.
- Methods
- Reader Method: seconds ((bert-time
bert-time
)) ¶
-
automatically generated reader method
- Source
bert.lisp
.
- Target Slot
seconds
.
- Generic Function: translate-complex-type (object) ¶
-
Translates tuples with the ’bert’ tag to corresponding Lisp objects.
- Package
bert
.
- Source
bert.lisp
.
- Methods
- Method: translate-complex-type (object) ¶
-
- Method: translate-complex-type ((lst
list
)) ¶
-
- Method: translate-complex-type ((tuple
erlang-tuple
)) ¶
-
- Method: translate-complex-type ((nil-symbol
(eql nil)
)) ¶
-
- Method: translate-complex-type ((dict
hash-table
)) ¶
-
- Method: translate-complex-type ((regex
bert-regex
)) ¶
-
- Method: translate-complex-type ((time
bert-time
)) ¶
-
6.2.3 Types
- Type: bert-translatable () ¶
-
A type that encompasses all types of Lisp objects that can be translated to BERT objects.
- Package
bert
.
- Source
bert.lisp
.
Appendix A Indexes
A.2 Functions
| |
|
B | | |
| bert-translatable-p : | | Private ordinary functions |
| bool : | | Public ordinary functions |
|
C | | |
| complex-bert-term-p : | | Private ordinary functions |
| compound-bert-term-p : | | Private ordinary functions |
|
D | | |
| decode : | | Public ordinary functions |
|
E | | |
| encode : | | Public generic functions |
| encode : | | Public generic functions |
|
F | | |
| Function, bert-translatable-p : | | Private ordinary functions |
| Function, bool : | | Public ordinary functions |
| Function, complex-bert-term-p : | | Private ordinary functions |
| Function, compound-bert-term-p : | | Private ordinary functions |
| Function, decode : | | Public ordinary functions |
| Function, simple-bert-term-p : | | Private ordinary functions |
| Function, translate-complex-term : | | Private ordinary functions |
| Function, translate-complex-terms : | | Private ordinary functions |
| Function, translate-dict-term : | | Private ordinary functions |
| Function, translate-regex-term : | | Private ordinary functions |
| Function, translate-time-term : | | Private ordinary functions |
|
G | | |
| Generic Function, encode : | | Public generic functions |
| Generic Function, megaseconds : | | Private generic functions |
| Generic Function, microseconds : | | Private generic functions |
| Generic Function, regex-options : | | Private generic functions |
| Generic Function, regex-source : | | Private generic functions |
| Generic Function, seconds : | | Private generic functions |
| Generic Function, translate-complex-type : | | Private generic functions |
|
M | | |
| megaseconds : | | Private generic functions |
| megaseconds : | | Private generic functions |
| Method, encode : | | Public generic functions |
| Method, megaseconds : | | Private generic functions |
| Method, microseconds : | | Private generic functions |
| Method, regex-options : | | Private generic functions |
| Method, regex-source : | | Private generic functions |
| Method, seconds : | | Private generic functions |
| Method, translate-complex-type : | | Private generic functions |
| Method, translate-complex-type : | | Private generic functions |
| Method, translate-complex-type : | | Private generic functions |
| Method, translate-complex-type : | | Private generic functions |
| Method, translate-complex-type : | | Private generic functions |
| Method, translate-complex-type : | | Private generic functions |
| Method, translate-complex-type : | | Private generic functions |
| microseconds : | | Private generic functions |
| microseconds : | | Private generic functions |
|
R | | |
| regex-options : | | Private generic functions |
| regex-options : | | Private generic functions |
| regex-source : | | Private generic functions |
| regex-source : | | Private generic functions |
|
S | | |
| seconds : | | Private generic functions |
| seconds : | | Private generic functions |
| simple-bert-term-p : | | Private ordinary functions |
|
T | | |
| translate-complex-term : | | Private ordinary functions |
| translate-complex-terms : | | Private ordinary functions |
| translate-complex-type : | | Private generic functions |
| translate-complex-type : | | Private generic functions |
| translate-complex-type : | | Private generic functions |
| translate-complex-type : | | Private generic functions |
| translate-complex-type : | | Private generic functions |
| translate-complex-type : | | Private generic functions |
| translate-complex-type : | | Private generic functions |
| translate-complex-type : | | Private generic functions |
| translate-dict-term : | | Private ordinary functions |
| translate-regex-term : | | Private ordinary functions |
| translate-time-term : | | Private ordinary functions |
|
A.4 Data types
| |
|
B | | |
| bert : | | The bert system |
| bert : | | The bert package |
| bert-regex : | | Public classes |
| bert-system : | | The bert-system package |
| bert-time : | | Public classes |
| bert-translatable : | | Private types |
| bert.asd : | | The bert/bert․asd file |
| bert.lisp : | | The bert/src/bert․lisp file |
|
C | | |
| Class, bert-regex : | | Public classes |
| Class, bert-time : | | Public classes |
|
F | | |
| File, bert.asd : | | The bert/bert․asd file |
| File, bert.lisp : | | The bert/src/bert․lisp file |
| File, packages.lisp : | | The bert/src/packages․lisp file |
|
M | | |
| Module, src : | | The bert/src module |
|
P | | |
| Package, bert : | | The bert package |
| Package, bert-system : | | The bert-system package |
| packages.lisp : | | The bert/src/packages․lisp file |
|
S | | |
| src : | | The bert/src module |
| System, bert : | | The bert system |
|
T | | |
| Type, bert-translatable : | | Private types |
|