The bert Reference Manual

Table of Contents

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

The bert Reference Manual

This is the bert Reference Manual, version 0.2.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:58:45 2018 GMT+0.


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

1 Introduction

cl-bert

cl-bert is a BERT serializer.

API

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

[Function]
decode bytes => object

[Function]
binary &rest bytes => binary

[Generic Function]
bytes binary => bytes

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

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

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

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

[Function]
tuple &rest objects => tuple

[Generic Function]
elements tuple => vector

[Generic Function]
arity tuple => arity

[Function]
bool value => bert-boolean


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 bert

Author

Markus Flambard <mflambard@common-lisp.net>

License

MIT License

Description

BERT serializer.

Version

0.2.1

Dependencies
Source

bert.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 bert/src

Parent

bert (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 bert.asd

Location

bert.asd

Systems

bert (system)

Packages

bert-system


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

4.1.2 bert/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

bert


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

4.1.3 bert/src/bert.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/bert.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 bert-system

Source

bert.asd

Use List

common-lisp


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

5.2 bert

BERT (Binary ERlang Term).

Source

packages.lisp (file)

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 Constants

Constant: false

BERT boolean false term.

Package

bert

Source

bert.lisp (file)

Constant: true

BERT boolean true term.

Package

bert

Source

bert.lisp (file)


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

6.1.2 Functions

Function: bool VALUE
Package

bert

Source

bert.lisp (file)

Function: decode BYTES
Package

bert

Source

bert.lisp (file)


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

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 (file)

Methods
Method: encode OBJECT &key BERP-HEADER

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

6.1.4 Classes

Class: bert-regex ()

BERT regex data type

Package

bert

Source

bert.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: source
Initargs

:source

Readers

regex-source (generic function)

Slot: options
Initargs

:options

Readers

regex-options (generic function)

Class: bert-time ()

BERT time data type

Package

bert

Source

bert.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: megaseconds
Initargs

:megaseconds

Readers

megaseconds (generic function)

Slot: seconds
Initargs

:seconds

Readers

seconds (generic function)

Slot: microseconds
Initargs

:microseconds

Readers

microseconds (generic function)


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

6.2 Internal definitions


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

6.2.1 Functions

Function: bert-translatable-p OBJECT

Returns true if OBJECT is translatable to an Erlang object.

Package

bert

Source

bert.lisp (file)

Function: complex-bert-term-p BERT-TERM
Package

bert

Source

bert.lisp (file)

Function: compound-bert-term-p BERT-TERM
Package

bert

Source

bert.lisp (file)

Function: simple-bert-term-p BERT-TERM
Package

bert

Source

bert.lisp (file)

Function: translate-complex-term TERM
Package

bert

Source

bert.lisp (file)

Function: translate-complex-terms TERM
Package

bert

Source

bert.lisp (file)

Function: translate-dict-term DICT
Package

bert

Source

bert.lisp (file)

Function: translate-regex-term SOURCE OPTIONS
Package

bert

Source

bert.lisp (file)

Function: translate-time-term MEGASECONDS SECONDS MICROSECONDS
Package

bert

Source

bert.lisp (file)


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

6.2.2 Generic functions

Generic Function: megaseconds OBJECT
Package

bert

Methods
Method: megaseconds (BERT-TIME bert-time)

automatically generated reader method

Source

bert.lisp (file)

Generic Function: microseconds OBJECT
Package

bert

Methods
Method: microseconds (BERT-TIME bert-time)

automatically generated reader method

Source

bert.lisp (file)

Generic Function: regex-options OBJECT
Package

bert

Methods
Method: regex-options (BERT-REGEX bert-regex)

automatically generated reader method

Source

bert.lisp (file)

Generic Function: regex-source OBJECT
Package

bert

Methods
Method: regex-source (BERT-REGEX bert-regex)

automatically generated reader method

Source

bert.lisp (file)

Generic Function: seconds OBJECT
Package

bert

Methods
Method: seconds (BERT-TIME bert-time)

automatically generated reader method

Source

bert.lisp (file)

Generic Function: translate-complex-type OBJECT

Translates tuples with the ’bert’ tag to corresponding Lisp objects.

Package

bert

Source

bert.lisp (file)

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)

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

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 (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   B   F   L   M  
Index Entry  Section

B
bert.asd: The bert<dot>asd file
bert/src: The bert/src module
bert/src/bert.lisp: The bert/src/bert<dot>lisp file
bert/src/packages.lisp: The bert/src/packages<dot>lisp file

F
File, Lisp, bert.asd: The bert<dot>asd file
File, Lisp, bert/src/bert.lisp: The bert/src/bert<dot>lisp file
File, Lisp, bert/src/packages.lisp: The bert/src/packages<dot>lisp file

L
Lisp File, bert.asd: The bert<dot>asd file
Lisp File, bert/src/bert.lisp: The bert/src/bert<dot>lisp file
Lisp File, bert/src/packages.lisp: The bert/src/packages<dot>lisp file

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

Jump to:   B   F   L   M  

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

A.2 Functions

Jump to:   B   C   D   E   F   G   M   R   S   T  
Index Entry  Section

B
bert-translatable-p: Internal functions
bool: Exported functions

C
complex-bert-term-p: Internal functions
compound-bert-term-p: Internal functions

D
decode: Exported functions

E
encode: Exported generic functions
encode: Exported generic functions

F
Function, bert-translatable-p: Internal functions
Function, bool: Exported functions
Function, complex-bert-term-p: Internal functions
Function, compound-bert-term-p: Internal functions
Function, decode: Exported functions
Function, simple-bert-term-p: Internal functions
Function, translate-complex-term: Internal functions
Function, translate-complex-terms: Internal functions
Function, translate-dict-term: Internal functions
Function, translate-regex-term: Internal functions
Function, translate-time-term: Internal functions

G
Generic Function, encode: Exported generic functions
Generic Function, megaseconds: Internal generic functions
Generic Function, microseconds: Internal generic functions
Generic Function, regex-options: Internal generic functions
Generic Function, regex-source: Internal generic functions
Generic Function, seconds: Internal generic functions
Generic Function, translate-complex-type: Internal generic functions

M
megaseconds: Internal generic functions
megaseconds: Internal generic functions
Method, encode: Exported generic functions
Method, megaseconds: Internal generic functions
Method, microseconds: Internal generic functions
Method, regex-options: Internal generic functions
Method, regex-source: Internal generic functions
Method, seconds: Internal generic functions
Method, translate-complex-type: Internal generic functions
Method, translate-complex-type: Internal generic functions
Method, translate-complex-type: Internal generic functions
Method, translate-complex-type: Internal generic functions
Method, translate-complex-type: Internal generic functions
Method, translate-complex-type: Internal generic functions
Method, translate-complex-type: Internal generic functions
microseconds: Internal generic functions
microseconds: Internal generic functions

R
regex-options: Internal generic functions
regex-options: Internal generic functions
regex-source: Internal generic functions
regex-source: Internal generic functions

S
seconds: Internal generic functions
seconds: Internal generic functions
simple-bert-term-p: Internal functions

T
translate-complex-term: Internal functions
translate-complex-terms: Internal functions
translate-complex-type: Internal generic functions
translate-complex-type: Internal generic functions
translate-complex-type: Internal generic functions
translate-complex-type: Internal generic functions
translate-complex-type: Internal generic functions
translate-complex-type: Internal generic functions
translate-complex-type: Internal generic functions
translate-complex-type: Internal generic functions
translate-dict-term: Internal functions
translate-regex-term: Internal functions
translate-time-term: Internal functions

Jump to:   B   C   D   E   F   G   M   R   S   T  

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

A.3 Variables

Jump to:   C   F   M   O   S   T  
Index Entry  Section

C
Constant, false: Exported constants
Constant, true: Exported constants

F
false: Exported constants

M
megaseconds: Exported classes
microseconds: Exported classes

O
options: Exported classes

S
seconds: Exported classes
Slot, megaseconds: Exported classes
Slot, microseconds: Exported classes
Slot, options: Exported classes
Slot, seconds: Exported classes
Slot, source: Exported classes
source: Exported classes

T
true: Exported constants

Jump to:   C   F   M   O   S   T  

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

A.4 Data types

Jump to:   B   C   P   S   T  
Index Entry  Section

B
bert: The bert system
bert: The bert package
bert-regex: Exported classes
bert-system: The bert-system package
bert-time: Exported classes
bert-translatable: Internal types

C
Class, bert-regex: Exported classes
Class, bert-time: Exported classes

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

S
System, bert: The bert system

T
Type, bert-translatable: Internal types

Jump to:   B   C   P   S   T