The erlang-term Reference Manual

4.1.1 erlang-term/erlang-term.asd

Source

erlang-term.asd.

Parent Component

erlang-term (system).

ASDF Systems

erlang-term.

Packages

erlang-term-system.

---

4.1.2 erlang-term/src/packages.lisp

Source

erlang-term.asd.

Parent Component

src (module).

Packages

• erlang-term.
• etf-bops.
• etf-atom-cache-interface.

---

4.1.3 erlang-term/src/macros.lisp

Dependency

packages.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Internals

multiple-value-bind* (macro).

---

4.1.4 erlang-term/src/conditions.lisp

Dependency

packages.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• bytes (reader method).
• bytes (reader method).
• bytes (reader method).
• bytes (reader method).
• malformed-external-erlang-term-error (condition).
• not-implemented-error (condition).
• unexpected-message-tag-error (condition).
• untranslatable-lisp-object-error (condition).

Internals

• atom-cache-missing-error (condition).
• atom-not-in-cache-error (condition).
• atom-reference (reader method).
• comment (reader method).
• expected-length (reader method).
• expected-tags (reader method).
• malformed-message-error (condition).
• object (reader method).
• received-length (reader method).
• received-tag (reader method).
• unexpected-message-length-error (condition).

---

4.1.5 erlang-term/src/special-variables.lisp

Dependency

packages.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• *atom-symbol-package* (special variable).
• *erlang-false-is-lisp-nil* (special variable).
• *erlang-string-is-lisp-string* (special variable).
• *erlang-true-is-lisp-t* (special variable).
• *lisp-nil-at-tail-is-erlang-empty-list* (special variable).
• *lisp-nil-is-erlang-empty-list* (special variable).
• *lisp-nil-is-erlang-false* (special variable).
• *lisp-string-is-erlang-binary* (special variable).
• *lisp-t-is-erlang-true* (special variable).

---

4.1.6 erlang-term/src/atom-cache-interface.lisp

Dependency

packages.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• *atom-cache* (special variable).
• get-atom (generic function).
• put-atom (generic function).

---

4.1.7 erlang-term/src/bops.lisp

Dependency

packages.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• bytes-to-double-float (function).
• bytes-to-signed-int32 (function).
• bytes-to-string (function).
• bytes-to-uint16 (function).
• bytes-to-uint32 (function).
• bytes-to-unsigned-integer (function).
• double-float-to-bytes (function).
• read-bytes (function).
• read-signed-int32 (function).
• read-string (function).
• read-uint16 (function).
• read-uint32 (function).
• signed-int32-to-bytes (function).
• string-to-byte-list (function).
• string-to-byte-vector (function).
• uint16-to-bytes (function).
• uint32-to-bytes (function).
• unsigned-integer-to-bytes (function).
• write-signed-int32 (function).
• write-uint16 (function).
• write-uint32 (function).

---

4.1.8 erlang-term/src/generic-functions.lisp

Dependency

packages.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• arity (generic function).
• match-p (generic function).
• size (generic function).

Internals

• decode-erlang-object (generic function).
• encode-erlang-object (generic function).

---

4.1.9 erlang-term/src/classes.lisp

Dependencies

• packages.lisp (file).
• generic-functions.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• arity (reader method).
• erlang-fun (class).
• erlang-internal-fun (class).
• erlang-object (class).
• make-load-form (method).
• match-p (method).
• module (reader method).
• node (reader method).

Internals

• erlang-identifier (class).
• free-vars (reader method).

---

4.1.10 erlang-term/src/type-erlang-translatable.lisp

Dependencies

• packages.lisp (file).
• classes.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• erlang-translatable (type).
• erlang-translatable-p (function).

---

4.1.11 erlang-term/src/compressed-term.lisp

Dependencies

• packages.lisp (file).
• bops.lisp (file).
• generic-functions.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Internals

• +compressed-term+ (constant).
• decode-erlang-object (method).
• zlib-compress (function).

---

4.1.12 erlang-term/src/coding-api.lisp

Dependencies

• packages.lisp (file).
• compressed-term.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• +protocol-version+ (constant).
• decode (function).
• encode (function).

---

4.1.13 erlang-term/src/erlang-atom.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• special-variables.lisp (file).
• atom-cache-interface.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• make-atom (function).
• match-p (method).

Internals

• +atom-cache-ref+ (constant).
• +atom-ext+ (constant).
• +small-atom-ext+ (constant).
• decode-erlang-atom (function).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-external-atom (function).
• decode-external-atom-cache-ref (function).
• decode-external-small-atom (function).
• encode-erlang-object (method).
• encode-external-atom (function).
• encode-external-atom-cache-ref (function).
• encode-external-small-atom (function).
• translate-erlang-boolean (function).

---

4.1.14 erlang-term/src/erlang-binary.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• special-variables.lisp (file).
• classes.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• binary (compiler macro).
• binary (function).
• binary-to-string (function).
• bits-in-last-byte (reader method).
• bytes (reader method).
• bytes-to-binary (function).
• erlang-binary (class).
• initialize-instance (method).
• match-p (method).
• print-object (method).
• size (method).
• string-to-binary (compiler macro).
• string-to-binary (function).

Internals

• +binary-ext+ (constant).
• +bit-binary-ext+ (constant).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-external-binary (function).
• decode-external-bit-binary (function).
• encode-erlang-object (method).
• encode-external-binary (function).
• encode-external-bit-binary (function).
• keep-bits (function).

---

4.1.15 erlang-term/src/erlang-float.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

match-p (method).

Internals

• +float-ext+ (constant).
• +new-float-ext+ (constant).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-external-float (function).
• decode-external-new-float (function).
• encode-erlang-object (method).
• encode-external-float (function).
• encode-external-new-float (function).

---

4.1.16 erlang-term/src/erlang-fun.lisp

Dependencies

• packages.lisp (file).
• macros.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• special-variables.lisp (file).
• classes.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• erlang-external-fun (class).
• erlang-new-internal-fun (class).
• erlang-old-internal-fun (class).
• match-p (method).
• match-p (method).
• match-p (method).
• match-p (method).
• print-object (method).

Internals

• +export-ext+ (constant).
• +fun-ext+ (constant).
• +new-fun-ext+ (constant).
• decode-external-export (function).
• decode-external-fun (function).
• decode-external-new-fun (function).
• encode-erlang-object (method).
• encode-erlang-object (method).
• encode-erlang-object (method).
• encode-external-export (function).
• encode-external-fun (function).
• encode-external-new-fun (function).

---

4.1.17 erlang-term/src/erlang-integer.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

match-p (method).

Internals

• +integer-ext+ (constant).
• +large-big-ext+ (constant).
• +small-big-ext+ (constant).
• +small-integer-ext+ (constant).
• bignum-byte-length (function).
• bignum-to-bytes (function).
• bytes-to-bignum (function).
• decode-erlang-integer (function).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-external-integer (function).
• decode-external-large-big (function).
• decode-external-small-big (function).
• decode-external-small-integer (function).
• encode-erlang-object (method).
• encode-external-integer (function).
• encode-external-large-big (function).
• encode-external-small-big (function).
• encode-external-small-integer (function).

---

4.1.18 erlang-term/src/erlang-list.lisp

Dependencies

• packages.lisp (file).
• macros.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• special-variables.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

match-p (method).

Internals

• +list-ext+ (constant).
• +nil-ext+ (constant).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-external-list (function).
• decode-external-nil (function).
• decode-list-contents (function).
• encode-erlang-object (method).
• encode-external-list (function).
• encode-external-nil (function).
• list-contents-to-bytes (function).

---

4.1.19 erlang-term/src/erlang-pid.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• special-variables.lisp (file).
• classes.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• erlang-pid (class).
• make-pid (function).
• match-p (method).
• print-object (method).

Internals

• +pid-ext+ (constant).
• decode-erlang-object (method).
• decode-erlang-pid (function).
• decode-external-pid (function).
• encode-erlang-object (method).
• encode-external-pid (function).

---

4.1.20 erlang-term/src/erlang-port.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• classes.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• erlang-port (class).
• make-port (function).
• print-object (method).

Internals

• +port-ext+ (constant).
• decode-erlang-object (method).
• decode-external-port (function).
• encode-erlang-object (method).
• encode-external-port (function).

---

4.1.21 erlang-term/src/erlang-reference.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• classes.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• erlang-reference (class).
• make-reference (function).
• print-object (method).

Internals

• +new-reference-ext+ (constant).
• +reference-ext+ (constant).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-external-new-reference (function).
• decode-external-reference (function).
• encode-erlang-object (method).
• encode-external-new-reference (function).
• encode-external-reference (function).
• four-byte-blocks (function).

---

4.1.22 erlang-term/src/erlang-string.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• special-variables.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

match-p (method).

Internals

• +string-ext+ (constant).
• decode-erlang-object (method).
• decode-external-string (function).
• encode-erlang-object (method).
• encode-external-string (function).

---

4.1.23 erlang-term/src/erlang-tuple.lisp

Dependencies

• packages.lisp (file).
• conditions.lisp (file).
• generic-functions.lisp (file).
• classes.lisp (file).
• bops.lisp (file).

Source

erlang-term.asd.

Parent Component

src (module).

Public Interface

• arity (method).
• elements (reader method).
• erlang-tuple (class).
• match-p (method).
• print-object (method).
• size (method).
• tuple (function).
• tuple-arity (function).
• tuple-ref (function).

Internals

• +large-tuple-ext+ (constant).
• +small-tuple-ext+ (constant).
• decode-erlang-object (method).
• decode-erlang-object (method).
• decode-external-large-tuple (function).
• decode-external-small-tuple (function).
• decode-tuple-contents (function).
• encode-erlang-object (method).
• encode-external-large-tuple (function).
• encode-external-small-tuple (function).
• mapconc-vector (function).

---

6.1.1 Constants

Constant: +protocol-version+ ¶

Package

erlang-term.

Source

coding-api.lisp.

---

6.1.2 Special variables

Special Variable: *atom-cache* ¶

The current atom cache. Bind this variable prior to encoding/decoding terms to make use of cached atoms in it.

Package

etf-atom-cache-interface.

Source

atom-cache-interface.lisp.

Special Variable: *atom-symbol-package* ¶

The package in which atom symbols are interned. Symbols are uninterned if NIL.

Package

erlang-term.

Source

special-variables.lisp.

Special Variable: *erlang-false-is-lisp-nil* ¶

Interpret the Erlang ’false’ as NIL instead of ’|false| in Lisp.

Package

erlang-term.

Source

special-variables.lisp.

Special Variable: *erlang-string-is-lisp-string* ¶

Interpret an Erlang string as Lisp string instead of a Lisp list.

Package

erlang-term.

Source

special-variables.lisp.

Special Variable: *erlang-true-is-lisp-t* ¶

Interpret the Erlang ’true’ as T instead of ’|true| in Lisp.

Package

erlang-term.

Source

special-variables.lisp.

Special Variable: *lisp-nil-at-tail-is-erlang-empty-list* ¶

Send the Lisp NIL at the tail of a list to Erlang as the empty list instead of as a symbol.

Package

erlang-term.

Source

special-variables.lisp.

Special Variable: *lisp-nil-is-erlang-empty-list* ¶

Send the Lisp NIL to Erlang as the empty list instead of as a symbol.

Package

erlang-term.

Source

special-variables.lisp.

Special Variable: *lisp-nil-is-erlang-false* ¶

Send the Lisp NIL to Erlang as ’false’ instead of ’NIL’.

Package

erlang-term.

Source

special-variables.lisp.

Special Variable: *lisp-string-is-erlang-binary* ¶

Send a Lisp string to Erlang as a binary instead of a list.

Package

erlang-term.

Source

special-variables.lisp.

Special Variable: *lisp-t-is-erlang-true* ¶

Send the Lisp T to Erlang as ’true’ instead of ’T’.

Package

erlang-term.

Source

special-variables.lisp.

---

6.1.3 Compiler macros

Compiler Macro: binary (&rest bytes) ¶

Package

erlang-term.

Source

erlang-binary.lisp.

Compiler Macro: string-to-binary (string) ¶

Package

erlang-term.

Source

erlang-binary.lisp.

---

6.1.4 Ordinary functions

Function: binary (&rest bytes) ¶

Creates an Erlang binary from BYTES.

Package

erlang-term.

Source

erlang-binary.lisp.

Function: binary-to-string (binary) ¶

Translates the bytes in BINARY to an ASCII string.

Package

erlang-term.

Source

erlang-binary.lisp.

Function: bytes-to-binary (bytes) ¶

Creates an Erlang binary from BYTES.

Package

erlang-term.

Source

erlang-binary.lisp.

Function: bytes-to-double-float (bytes) ¶

Package

etf-bops.

Source

bops.lisp.

Function: bytes-to-signed-int32 (bytes &optional pos) ¶

Package

etf-bops.

Source

bops.lisp.

Function: bytes-to-string (bytes &optional length pos) ¶

Package

etf-bops.

Source

bops.lisp.

Function: bytes-to-uint16 (bytes &optional pos) ¶

Package

etf-bops.

Source

bops.lisp.

Function: bytes-to-uint32 (bytes &optional pos) ¶

Package

etf-bops.

Source

bops.lisp.

Function: bytes-to-unsigned-integer (bytes &optional number-of-bytes pos) ¶

Package

etf-bops.

Source

bops.lisp.

Function: decode (bytes &key start version-tag) ¶

Decode a sequence of bytes to an Erlang object.

Package

erlang-term.

Source

coding-api.lisp.

Function: double-float-to-bytes (f) ¶

Package

etf-bops.

Source

bops.lisp.

Function: encode (term &key version-tag compressed) ¶

Encode an Erlang object into a sequence of bytes.

Package

erlang-term.

Source

coding-api.lisp.

Function: erlang-translatable-p (object) ¶

Returns true if OBJECT is translatable to an Erlang object.

Package

erlang-term.

Source

type-erlang-translatable.lisp.

Function: make-atom (string) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: make-pid (node id serial creation) ¶

Package

erlang-term.

Source

erlang-pid.lisp.

Function: make-port (node id creation) ¶

Package

erlang-term.

Source

erlang-port.lisp.

Function: make-reference (node id creation) ¶

Package

erlang-term.

Source

erlang-reference.lisp.

Function: read-bytes (n stream) ¶

Package

etf-bops.

Source

bops.lisp.

Function: read-signed-int32 (stream) ¶

Package

etf-bops.

Source

bops.lisp.

Function: read-string (n stream) ¶

Package

etf-bops.

Source

bops.lisp.

Function: read-uint16 (stream) ¶

Package

etf-bops.

Source

bops.lisp.

Function: read-uint32 (stream) ¶

Package

etf-bops.

Source

bops.lisp.

Function: signed-int32-to-bytes (int) ¶

Package

etf-bops.

Source

bops.lisp.

Function: string-to-binary (string) ¶

Creates an Erlang binary from the characters in STRING.

Package

erlang-term.

Source

erlang-binary.lisp.

Function: string-to-byte-list (string) ¶

Package

etf-bops.

Source

bops.lisp.

Function: string-to-byte-vector (string) ¶

Package

etf-bops.

Source

bops.lisp.

Function: tuple (&rest erlang-translatable-objects) ¶

Create an Erlang tuple

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: tuple-arity (tuple) ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: tuple-ref (tuple pos) ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: uint16-to-bytes (int) ¶

Package

etf-bops.

Source

bops.lisp.

Function: uint32-to-bytes (int) ¶

Package

etf-bops.

Source

bops.lisp.

Function: unsigned-integer-to-bytes (uint number-of-bytes) ¶

Package

etf-bops.

Source

bops.lisp.

Function: write-signed-int32 (int stream) ¶

Package

etf-bops.

Source

bops.lisp.

Function: write-uint16 (int stream) ¶

Package

etf-bops.

Source

bops.lisp.

Function: write-uint32 (int stream) ¶

Package

etf-bops.

Source

bops.lisp.

---

6.1.5 Generic functions

Generic Function: arity (tuple-or-fun) ¶

Returns the arity of an Erlang tuple or fun.

Package

erlang-term.

Source

generic-functions.lisp.

Methods

Method: arity ((x erlang-tuple)) ¶

The number of elements of Erlang tuple X.

Source

erlang-tuple.lisp.

Reader Method: arity ((erlang-fun erlang-fun)) ¶

The arity of an Erlang Fun.

Source

classes.lisp.

Target Slot

arity.

Generic Reader: bits-in-last-byte (object) ¶

Package

erlang-term.

Methods

Reader Method: bits-in-last-byte ((erlang-binary erlang-binary)) ¶

The number of bits in the last byte of an Erlang binary.

Source

erlang-binary.lisp.

Target Slot

bits.

Generic Reader: bytes (condition) ¶

Package

erlang-term.

Methods

Reader Method: bytes ((erlang-binary erlang-binary)) ¶

Returns a vector of bytes from an Erlang binary.

Source

erlang-binary.lisp.

Target Slot

bytes.

Reader Method: bytes ((condition malformed-external-erlang-term-error)) ¶

Source

conditions.lisp.

Target Slot

bytes.

Reader Method: bytes ((condition malformed-message-error)) ¶

Source

conditions.lisp.

Target Slot

bytes.

Reader Method: bytes ((condition atom-not-in-cache-error)) ¶

Source

conditions.lisp.

Target Slot

bytes.

Reader Method: bytes ((condition atom-cache-missing-error)) ¶

Source

conditions.lisp.

Target Slot

bytes.

Generic Reader: elements (object) ¶

Package

erlang-term.

Methods

Reader Method: elements ((erlang-tuple erlang-tuple)) ¶

automatically generated reader method

Source

erlang-tuple.lisp.

Target Slot

elements.

Generic Function: get-atom (reference cache) ¶

Get and return the atom from CACHE identified by REFERENCE.
The second return value is a boolean that indicates whether an atom was found for REFERENCE. The first return value is NIL when no atom is found.

Package

etf-atom-cache-interface.

Source

atom-cache-interface.lisp.

Generic Function: match-p (object-a object-b) ¶

Predicate for testing if two Erlang objects match.

Package

erlang-term.

Source

generic-functions.lisp.

Methods

Method: match-p ((a erlang-tuple) (b erlang-tuple)) ¶

Source

erlang-tuple.lisp.

Method: match-p ((a string) (b string)) ¶

Source

erlang-string.lisp.

Method: match-p ((a erlang-pid) (b erlang-pid)) ¶

Source

erlang-pid.lisp.

Method: match-p ((a list) (b list)) ¶

Source

erlang-list.lisp.

Method: match-p ((a integer) (b integer)) ¶

Source

erlang-integer.lisp.

Method: match-p ((a erlang-new-internal-fun) (b erlang-new-internal-fun)) ¶

Source

erlang-fun.lisp.

Method: match-p ((a erlang-internal-fun) (b erlang-internal-fun)) ¶

Source

erlang-fun.lisp.

Method: match-p ((a erlang-external-fun) (b erlang-external-fun)) ¶

Source

erlang-fun.lisp.

Method: match-p ((a erlang-fun) (b erlang-fun)) ¶

Source

erlang-fun.lisp.

Method: match-p ((a float) (b float)) ¶

Source

erlang-float.lisp.

Method: match-p ((a erlang-binary) (b erlang-binary)) ¶

Source

erlang-binary.lisp.

Method: match-p ((a symbol) (b symbol)) ¶

Source

erlang-atom.lisp.

Method: match-p ((a erlang-identifier) (b erlang-identifier)) ¶

Source

classes.lisp.

Method: match-p (a b) ¶

Generic Reader: module (object) ¶

Package

erlang-term.

Methods

Reader Method: module ((erlang-fun erlang-fun)) ¶

automatically generated reader method

Source

classes.lisp.

Target Slot

module.

Generic Reader: node (object) ¶

Package

erlang-term.

Methods

Reader Method: node ((erlang-identifier erlang-identifier)) ¶

automatically generated reader method

Source

classes.lisp.

Target Slot

node.

Generic Function: put-atom (atom cache) ¶

Put ATOM into CACHE, creating a new entry for it if it does
not already exist. Returns the reference that identifies the atom, otherwise returns NIL if for some reason the atom could not be cached.

Package

etf-atom-cache-interface.

Source

atom-cache-interface.lisp.

Generic Function: size (tuple-or-binary) ¶

Returns the size of an Erlang tuple or binary.

Package

erlang-term.

Source

generic-functions.lisp.

Methods

Method: size ((x erlang-tuple)) ¶

The number of elements of Erlang tuple X.

Source

erlang-tuple.lisp.

Method: size ((x erlang-binary)) ¶

The byte-size of Erlang binary X.

Source

erlang-binary.lisp.

---

6.1.6 Standalone methods

Method: initialize-instance :after ((object erlang-binary) &key bits bytes &allow-other-keys) ¶

Strip unused bits in last byte when making a bit-binary.

Source

erlang-binary.lisp.

Method: make-load-form ((object erlang-object) &optional environment) ¶

Source

classes.lisp.

Method: print-object ((object erlang-port) stream) ¶

Source

erlang-port.lisp.

Method: print-object ((object erlang-reference) stream) ¶

Source

erlang-reference.lisp.

Method: print-object ((object erlang-binary) stream) ¶

Source

erlang-binary.lisp.

Method: print-object ((object erlang-pid) stream) ¶

Source

erlang-pid.lisp.

Method: print-object ((object erlang-tuple) stream) ¶

Source

erlang-tuple.lisp.

Method: print-object ((object erlang-external-fun) stream) ¶

Source

erlang-fun.lisp.

---

6.1.7 Conditions

Condition: malformed-external-erlang-term-error ¶

This error is signaled when an encoded Erlang term is malformed.

Package

erlang-term.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

bytes.

Direct slots

Slot: bytes ¶

Initargs

:bytes

Readers

bytes.

Writers

This slot is read-only.

Condition: not-implemented-error ¶

The signaling function is not implemented yet.

Package

erlang-term.

Source

conditions.lisp.

Direct superclasses

program-error.

Direct methods

comment.

Direct slots

Slot: comment ¶

Initargs

:comment

Readers

comment.

Writers

This slot is read-only.

Condition: unexpected-message-tag-error ¶

This error is signaled when an unexpected message tag is read.

Package

erlang-term.

Source

conditions.lisp.

Direct superclasses

malformed-message-error.

Direct methods

• expected-tags.
• received-tag.

Direct slots

Slot: received-tag ¶

Initargs

:received-tag

Readers

received-tag.

Writers

This slot is read-only.

Slot: expected-tags ¶

Initargs

:expected-tags

Readers

expected-tags.

Writers

This slot is read-only.

Condition: untranslatable-lisp-object-error ¶

This error is signaled when trying to encode an unencodable object.

Package

erlang-term.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

object.

Direct slots

Slot: object ¶

Initargs

:object

Readers

object.

Writers

This slot is read-only.

---

6.1.8 Classes

Class: erlang-binary ¶

Erlang binary.

Package

erlang-term.

Source

erlang-binary.lisp.

Direct superclasses

erlang-object.

Direct methods

• bits-in-last-byte.
• bytes.
• encode-erlang-object.
• initialize-instance.
• match-p.
• print-object.
• size.

Direct slots

Slot: bytes ¶

Returns a vector of bytes from an Erlang binary.

Initargs

:bytes

Readers

bytes.

Writers

This slot is read-only.

Slot: bits ¶

The number of bits in the last byte of an Erlang binary.

Initform

8

Initargs

:bits

Readers

bits-in-last-byte.

Writers

This slot is read-only.

Class: erlang-external-fun ¶

Erlang fun in external format (module:function/arity).

Package

erlang-term.

Source

erlang-fun.lisp.

Direct superclasses

erlang-fun.

Direct methods

• encode-erlang-object.
• match-p.
• print-object.

Direct slots

Slot: function ¶

Package

common-lisp.

Initargs

:function

Class: erlang-fun ¶

Erlang fun.

Package

erlang-term.

Source

classes.lisp.

Direct superclasses

erlang-object.

Direct subclasses

• erlang-external-fun.
• erlang-internal-fun.

Direct methods

• arity.
• match-p.
• module.

Direct slots

Slot: module ¶

Initargs

:module

Readers

module.

Writers

This slot is read-only.

Slot: arity ¶

The arity of an Erlang Fun.

Initargs

:arity

Readers

arity.

Writers

This slot is read-only.

Class: erlang-internal-fun ¶

Erlang fun in internal format.

Package

erlang-term.

Source

classes.lisp.

Direct superclasses

erlang-fun.

Direct subclasses

• erlang-new-internal-fun.
• erlang-old-internal-fun.

Direct methods

• free-vars.
• match-p.

Direct slots

Slot: pid ¶

Initargs

:pid

Slot: index ¶

Initargs

:index

Slot: uniq ¶

Initargs

:uniq

Slot: free-vars ¶

Initargs

:free-vars

Readers

free-vars.

Writers

This slot is read-only.

Class: erlang-new-internal-fun ¶

Erlang fun in new internal format.

Package

erlang-term.

Source

erlang-fun.lisp.

Direct superclasses

erlang-internal-fun.

Direct methods

• encode-erlang-object.
• match-p.

Direct slots

Slot: index ¶

Initargs

:old-index

Slot: uniq ¶

Initargs

:old-uniq

Slot: new-uniq ¶

Initargs

:uniq

Slot: new-index ¶

Initargs

:index

Class: erlang-object ¶

Package

erlang-term.

Source

classes.lisp.

Direct subclasses

• erlang-binary.
• erlang-fun.
• erlang-identifier.
• erlang-tuple.

Direct methods

make-load-form.

Class: erlang-old-internal-fun ¶

Erlang fun in old internal-format

Package

erlang-term.

Source

erlang-fun.lisp.

Direct superclasses

erlang-internal-fun.

Direct methods

encode-erlang-object.

Class: erlang-pid ¶

Erlang PID.

Package

erlang-term.

Source

erlang-pid.lisp.

Direct superclasses

erlang-identifier.

Direct methods

• encode-erlang-object.
• match-p.
• print-object.

Direct slots

Slot: serial ¶

Initargs

:serial

Class: erlang-port ¶

Erlang port.

Package

erlang-term.

Source

erlang-port.lisp.

Direct superclasses

erlang-identifier.

Direct methods

• encode-erlang-object.
• print-object.

Class: erlang-reference ¶

Erlang ref.

Package

erlang-term.

Source

erlang-reference.lisp.

Direct superclasses

erlang-identifier.

Direct methods

• encode-erlang-object.
• print-object.

Class: erlang-tuple ¶

Erlang tuple.

Package

erlang-term.

Source

erlang-tuple.lisp.

Direct superclasses

erlang-object.

Direct methods

• arity.
• elements.
• encode-erlang-object.
• match-p.
• print-object.
• size.

Direct slots

Slot: elements ¶

Initargs

:elements

Readers

elements.

Writers

This slot is read-only.

---

6.1.9 Types

Type: erlang-translatable () ¶

A type that encompasses all types of Lisp objects that can be translated to Erlang objects.

Package

erlang-term.

Source

type-erlang-translatable.lisp.

---

6.2.1 Constants

Constant: +atom-cache-ref+ ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Constant: +atom-ext+ ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Constant: +binary-ext+ ¶

Package

erlang-term.

Source

erlang-binary.lisp.

Constant: +bit-binary-ext+ ¶

Package

erlang-term.

Source

erlang-binary.lisp.

Constant: +compressed-term+ ¶

Package

erlang-term.

Source

compressed-term.lisp.

Constant: +export-ext+ ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Constant: +float-ext+ ¶

Package

erlang-term.

Source

erlang-float.lisp.

Constant: +fun-ext+ ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Constant: +integer-ext+ ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Constant: +large-big-ext+ ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Constant: +large-tuple-ext+ ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Constant: +list-ext+ ¶

Package

erlang-term.

Source

erlang-list.lisp.

Constant: +new-float-ext+ ¶

Package

erlang-term.

Source

erlang-float.lisp.

Constant: +new-fun-ext+ ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Constant: +new-reference-ext+ ¶

Package

erlang-term.

Source

erlang-reference.lisp.

Constant: +nil-ext+ ¶

Package

erlang-term.

Source

erlang-list.lisp.

Constant: +pid-ext+ ¶

Package

erlang-term.

Source

erlang-pid.lisp.

Constant: +port-ext+ ¶

Package

erlang-term.

Source

erlang-port.lisp.

Constant: +reference-ext+ ¶

Package

erlang-term.

Source

erlang-reference.lisp.

Constant: +small-atom-ext+ ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Constant: +small-big-ext+ ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Constant: +small-integer-ext+ ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Constant: +small-tuple-ext+ ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Constant: +string-ext+ ¶

Package

erlang-term.

Source

erlang-string.lisp.

---

6.2.2 Macros

Macro: multiple-value-bind* (bind-clauses &body body) ¶

Package

erlang-term.

Source

macros.lisp.

---

6.2.3 Ordinary functions

Function: bignum-byte-length (bignum) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: bignum-to-bytes (bignum length) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: bytes-to-bignum (bytes &optional number-of-bytes pos) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: decode-erlang-atom (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: decode-erlang-integer (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: decode-erlang-pid (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-pid.lisp.

Function: decode-external-atom (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: decode-external-atom-cache-ref (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: decode-external-binary (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-binary.lisp.

Function: decode-external-bit-binary (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-binary.lisp.

Function: decode-external-export (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Function: decode-external-float (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-float.lisp.

Function: decode-external-fun (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Function: decode-external-integer (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: decode-external-large-big (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: decode-external-large-tuple (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: decode-external-list (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-list.lisp.

Function: decode-external-new-float (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-float.lisp.

Function: decode-external-new-fun (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Function: decode-external-new-reference (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-reference.lisp.

Function: decode-external-nil (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-list.lisp.

Function: decode-external-pid (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-pid.lisp.

Function: decode-external-port (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-port.lisp.

Function: decode-external-reference (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-reference.lisp.

Function: decode-external-small-atom (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: decode-external-small-big (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: decode-external-small-integer (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: decode-external-small-tuple (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: decode-external-string (bytes &optional pos) ¶

Package

erlang-term.

Source

erlang-string.lisp.

Function: decode-list-contents (bytes length &optional pos) ¶

Package

erlang-term.

Source

erlang-list.lisp.

Function: decode-tuple-contents (bytes arity pos) ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: encode-external-atom (atom) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: encode-external-atom-cache-ref (reference-index) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: encode-external-binary (erlang-binary) ¶

Package

erlang-term.

Source

erlang-binary.lisp.

Function: encode-external-bit-binary (erlang-binary) ¶

Package

erlang-term.

Source

erlang-binary.lisp.

Function: encode-external-export (fun) ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Function: encode-external-float (float) ¶

Package

erlang-term.

Source

erlang-float.lisp.

Function: encode-external-fun (fun) ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Function: encode-external-integer (int32) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: encode-external-large-big (bignum) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: encode-external-large-tuple (tuple) ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: encode-external-list (list) ¶

Package

erlang-term.

Source

erlang-list.lisp.

Function: encode-external-new-float (double-float) ¶

Package

erlang-term.

Source

erlang-float.lisp.

Function: encode-external-new-fun (fun) ¶

Package

erlang-term.

Source

erlang-fun.lisp.

Function: encode-external-new-reference (ref) ¶

Package

erlang-term.

Source

erlang-reference.lisp.

Function: encode-external-nil () ¶

Package

erlang-term.

Source

erlang-list.lisp.

Function: encode-external-pid (pid) ¶

Package

erlang-term.

Source

erlang-pid.lisp.

Function: encode-external-port (port) ¶

Package

erlang-term.

Source

erlang-port.lisp.

Function: encode-external-reference (ref) ¶

Package

erlang-term.

Source

erlang-reference.lisp.

Function: encode-external-small-atom (atom) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: encode-external-small-big (bignum) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: encode-external-small-integer (uint8) ¶

Package

erlang-term.

Source

erlang-integer.lisp.

Function: encode-external-small-tuple (tuple) ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: encode-external-string (chars) ¶

Package

erlang-term.

Source

erlang-string.lisp.

Function: four-byte-blocks (bytes) ¶

Package

erlang-term.

Source

erlang-reference.lisp.

Function: keep-bits (byte bits) ¶

Package

erlang-term.

Source

erlang-binary.lisp.

Function: list-contents-to-bytes (list) ¶

Package

erlang-term.

Source

erlang-list.lisp.

Function: mapconc-vector (fn vector) ¶

Package

erlang-term.

Source

erlang-tuple.lisp.

Function: translate-erlang-boolean (symbol) ¶

Package

erlang-term.

Source

erlang-atom.lisp.

Function: zlib-compress (bytes) ¶

Package

erlang-term.

Source

compressed-term.lisp.

---