The cl-conspack Reference Manual

Table of Contents

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

The cl-conspack Reference Manual

This is the cl-conspack Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:02:14 2018 GMT+0.


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

1 Introduction

News

Recent changes:

cl-conspack

CONSPACK was inspired by MessagePack, and by the general lack of features among prominent serial/wire formats:

It should be noted that, significantly, none of these support references. Of course, references can be implemented at a higher layer (e.g., JSPON), but this requires implemeting an entire additional layer of abstraction and escaping, including rewalking the parsed object hierarchy and looking for specific signatures, which can be error-prone, and hurt performance.

Additionally, none of these appear to have much in the way of security, and communicating with an untrusted peer is probably not recommended.

CONSPACK, on the other hand, attempts to be a more robust solution:

See SPEC for complete details on encoding.

Usage

cl-conspack is simple to use:

(encode '(1 2 3)) ;; => #(40 4 16 1 16 2 16 3 0)

(decode (encode '(1 2 3))) ;; => (1 2 3)

;; Smaller if the element-type is known:
(encode (fast-io:octets-from '(1 2 3)))
  ;; => #(36 3 20 1 2 3)

CLOS and general objects

Conspack provides the ability to serialize and deserialize objects of any kind.

The easiest way, for the common case:

(conspack:defencoding my-class
  slot-1 slot-2 slot-3)

This expands to the more flexible way, which specializes ENCODE-OBJECT and DECODE-OBJECT:

(defmethod conspack:encode-object ((object my-class) &key &allow-other-keys)
  (conspack:slots-to-alist (object)
    slot-1 slot-2 slot-3 ...))

(defmethod conspack:decode-object ((class (eql 'my-class)) alist
                                   &key &allow-other-keys)
  (alist-to-slots (alist :class my-class)
    slot-1 slot-2 slot-3))

ENCODE-OBJECT should specialize on the object and return an alist. The alist returned will be checked for circularity of tracking-refs is in use.

DECODE-OBJECT should specialize on (eql 'class-name), and produce an object based on the alist.

As you can see, this does not require objects be in any particular format, or that you store any particular slots or values. It does not specify how you restore an object.

But for the "normal" case, SLOTS-TO-ALIST and ALIST-TO-SLOTS are provided to build and restore from alists, and DEFENCODING can define all of this in one simple form.

Circularity and References

Circularity tracking is not on by default, you can enable it for a particular block of encodes or decodes by using tracking-refs:

(tracking-refs ()
  (decode (encode CIRCULAR-OBJECT)))

"Remote" references are application-level references. You may encode a reference using an arbitrary object as a descriptor:

(encode (r-ref '((:url . "http://..."))))

When decoding, you may provide a function to handle these:

(with-remote-refs (lambda (x) (decode-url x))
  (decode OBJECT))

Indexes

If you have a relatively small static set of symbols you will always use for a particular encoding/decoding, you may want to use indexes. These allow symbols to be very-tightly-packed: for up to 15 symbols, a single byte can encode the symbol! For up to 256, two bytes, and so on.

Trivially:

(cpk:with-index (specifier-1 specifier-2 specifier-3)
  (cpk:encode '(specifier-1 specifier-2 specifier-3)))

;; => #(40 4 176 177 178 0)

;; Contrast this with:

(cpk:encode '(specifier-1 specifier-2 specifier-3))
;; #(40 4 130 64 11 83 80 69 67 73 70 73 69 82 45 49 129 64 16 67 79
;; 77 77 79 78 45 76 73 83 80 45 85 83 69 82 130 64 11 83 80 69 67 73
;; 70 73 69 82 45 50 129 64 16 67 79 77 77 79 78 45 76 73 83 80 45 85
;; 83 69 82 130 64 11 83 80 69 67 73 70 73 69 82 45 51 129 64 16 67 79
;; 77 77 79 78 45 76 73 83 80 45 85 83 69 82 0)

(This is a somewhat excessive example, since long non-keyword symbols are used. Shorter keyword symbols would be relatively shorter, but this is the general case.)

For more "realistic" use, you may define an index and refer to it:

(define-index index-name
  symbol-1 symbol-2 ...)

(with-named-index 'index-name
  (encode ...))

For instance, you may define multiple indexes for multiple different format versions, read the version, and use the appropriate index:

(define-index version-1 ...)
(define-index version-2 ...)

(let ((version (decode-stream s)))
  (with-named-index version
    ;; Decode the rest of the stream appropriately.  You may want to
    ;; do more checking on VERSION if security is required...
    (decode-stream s)))

Note that using tracking-refs will also help encode symbols efficiently, but not quite as efficiently:

However, tracking-refs is a perfectly suitable option, especially if flexibility is desired, since all symbol information is encoded, and nothing special is needed for decoding.

Properties

(Properties now require a WITH-PROPERTIES block in some circumstances, see below.)

Properties are a way to specify additional information about an object that may be useful at decode-time. For instance, while hash tables are supported as maps, there are no bits to specify the :test parameter, so decoding a hash table of strings would produce a useless object. In this case, the :test property is set when encoding and checked when decoding hash tables.

You may specify arbitrary properties for arbitrary objects; the only restriction is the objects must test by EQ.

(conspack:with-properties ()
  (let ((object (make-instance ...)))
    (setf (property object :foo) 'bar)
    (property object :foo))) ;; => BAR

This sets the :foo property to the symbol bar, and it is encoded along with the object. Note this will increase the object size, by the amount required to store a map of symbols-to-values.

When decoding, you can access properties about an object via *current-properties*:

(defmethod decode-object (...)
  (let ((prop (getf *current-properties* NAME)))
    ...))

You may remove them with remove-property or remove-properties.

Properties are now only available within a WITH-PROPERTIES block. This has a number of benefits, including some thread safety, and ensuring properties don't stick around forever.

ENCODE and DECODE have implicit WITH-PROPERTIES blocks: you don't need to specify WITH-PROPERTIES if you use properties inside ENCODE-OBJECT, DECODE-OBJECT, or encode and decode any objects that have implicit properties. You only need this if you wish to access properties outside of the encode or decode (e.g., preassigning properties to be encoded).

Allocation Limits and Security

Conspack provides some level of "security" by approximately limiting the amount of bytes allocated when reading objects.

By default, because format sizes are prespecified statically, it's possible to specify extremely large allocations for e.g. arrays with only a few bytes. Obviously, this is not suitable for untrusted conspack data.

The solution is simply to cap allocations:

(with-conspack-security (:max-bytes 200000)
  (decode ...))

Since actual allocation sizes are rather difficult to get in most lisps, this approximates the allocation based on how big each object might be, e.g.:

Each object header is tallied against the limit just prior to its decoding; if the object would exceed the allowed bytes, decoding halts with an error.

Further options may be added in the future.

Explaining

Since conspack is a binary format, it's rather difficult for humans to read just looking at the stream of bytes. Thus an EXPLAIN feature is provided. This is mostly useful for debugging the format; however it may be of interest otherwise and certainly may be helpful when creating other implementations.

For instance:

(explain (encode '(1 2 3)))

;; =>
((:LIST 4
  ((:NUMBER :INT8 1) (:NUMBER :INT8 2) (:NUMBER :INT8 3) (:BOOLEAN NIL)))
 END-OF-FILE)

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 cl-conspack

Author

Ryan Pavlik

License

NewBSD

Description

CONSPACK implementation for Common Lisp

Dependencies
Source

cl-conspack.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 cl-conspack.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/cl-conspack-20170403-git/cl-conspack.asd

Systems

cl-conspack (system)

Packages

cl-conspack.asdf


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

3.1.2 cl-conspack/package.lisp

Parent

cl-conspack (system)

Location

package.lisp

Packages

conspack


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

3.1.3 cl-conspack/util.lisp

Dependency

package.lisp (file)

Parent

cl-conspack (system)

Location

util.lisp

Internal Definitions

aval (function)


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

3.1.4 cl-conspack/types.lisp

Dependency

util.lisp (file)

Parent

cl-conspack (system)

Location

types.lisp

Exported Definitions
Internal Definitions

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

3.1.5 cl-conspack/properties.lisp

Dependency

types.lisp (file)

Parent

cl-conspack (system)

Location

properties.lisp

Exported Definitions
Internal Definitions

*properties* (special variable)


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

3.1.6 cl-conspack/secure.lisp

Dependency

properties.lisp (file)

Parent

cl-conspack (system)

Location

secure.lisp

Exported Definitions
Internal Definitions

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

3.1.7 cl-conspack/reftable.lisp

Dependency

secure.lisp (file)

Parent

cl-conspack (system)

Location

reftable.lisp

Exported Definitions
Internal Definitions

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

3.1.8 cl-conspack/r-ref.lisp

Dependency

reftable.lisp (file)

Parent

cl-conspack (system)

Location

r-ref.lisp

Exported Definitions
Internal Definitions

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

3.1.9 cl-conspack/headers.lisp

Dependency

r-ref.lisp (file)

Parent

cl-conspack (system)

Location

headers.lisp

Internal Definitions

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

3.1.10 cl-conspack/indexes.lisp

Dependency

headers.lisp (file)

Parent

cl-conspack (system)

Location

indexes.lisp

Exported Definitions
Internal Definitions

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

3.1.11 cl-conspack/tmap.lisp

Dependency

indexes.lisp (file)

Parent

cl-conspack (system)

Location

tmap.lisp

Exported Definitions

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

3.1.12 cl-conspack/encode.lisp

Dependency

tmap.lisp (file)

Parent

cl-conspack (system)

Location

encode.lisp

Exported Definitions
Internal Definitions

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

3.1.13 cl-conspack/decode.lisp

Dependency

encode.lisp (file)

Parent

cl-conspack (system)

Location

decode.lisp

Exported Definitions
Internal Definitions

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

3.1.14 cl-conspack/explain.lisp

Dependency

decode.lisp (file)

Parent

cl-conspack (system)

Location

explain.lisp

Exported Definitions

explain (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-conspack.asdf

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-conspack-20170403-git/cl-conspack.asd

Use List

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

4.2 conspack

Source

package.lisp (file)

Nickname

cpk

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *conspack-forward-refs*
Package

conspack

Source

secure.lisp (file)

Special Variable: *conspack-max-bytes*
Package

conspack

Source

secure.lisp (file)

Special Variable: *current-properties*
Package

conspack

Source

decode.lisp (file)


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

5.1.2 Macros

Macro: alist-to-slots (ALIST &key INSTANCE CLASS) &body SLOT-NAMES

Set slots via ‘(SETF (SLOT-VALUE ...))‘ based on the values of the slots specified.

If ‘INSTANCE‘ is specified, slots are set on the provided value.

If ‘CLASS‘ is specified, trivially create an instance
via ‘(MAKE-INSTANCE ’CLASS)‘, quoted. If you need more complex initialization, specify ‘:INSTANCE‘ with your own ‘MAKE-INSTANCE‘.

You may not use both ‘:INSTANCE‘ and ‘:CLASS‘.

Package

conspack

Source

tmap.lisp (file)

Macro: defencoding CLASS-NAME &body SLOT-NAMES

Trivially define ‘ENCODE-OBJECT‘ and ‘DECODE-OBJECT‘ to store and load the given slots.

Package

conspack

Source

tmap.lisp (file)

Macro: define-index NAME &rest VALUES
Package

conspack

Source

indexes.lisp (file)

Macro: slots-to-alist (INSTANCE) &body SLOT-NAMES

Produce an ‘ALIST‘ of slot-names-to-slot-values, suitable for ‘ENCODE-OBJECT‘.

Package

conspack

Source

tmap.lisp (file)

Macro: tracking-refs REF-CONTEXT &body BODY
Package

conspack

Source

reftable.lisp (file)

Macro: with-conspack-security (&key MAX-BYTES FORWARD-REFS) &body BODY
Package

conspack

Source

secure.lisp (file)

Macro: with-index (&rest VALUES) &body BODY
Package

conspack

Source

indexes.lisp (file)

Macro: with-interning () &body BODY
Package

conspack

Source

decode.lisp (file)

Macro: with-named-index NAME &body BODY
Package

conspack

Source

indexes.lisp (file)

Macro: with-properties () &body BODY
Package

conspack

Source

properties.lisp (file)

Macro: with-remote-refs FUN &body BODY
Package

conspack

Source

r-ref.lisp (file)


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

5.1.3 Functions

Function: clear-refs &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: decode BYTE-VECTOR &optional OFFSET
Package

conspack

Source

decode.lisp (file)

Function: decode-file PATH
Package

conspack

Source

decode.lisp (file)

Function: decode-stream STREAM &optional OFFSET
Package

conspack

Source

decode.lisp (file)

Function: decode-value BUFFER &optional HEADER
Package

conspack

Source

decode.lisp (file)

Function: delete-index NAME
Package

conspack

Source

indexes.lisp (file)

Function: encode VALUE &key STREAM
Package

conspack

Source

encode.lisp (file)

Function: encode-to-buffer VALUE FAST-IO-BUFFER
Package

conspack

Source

encode.lisp (file)

Function: encode-to-file VALUE FILENAME
Package

conspack

Source

encode.lisp (file)

Function: explain VECTOR
Package

conspack

Source

explain.lisp (file)

Function: find-in-index SYMBOL-OR-NUMBER &optional INDEX
Package

conspack

Source

indexes.lisp (file)

Function: make-index VALUES &optional NAME
Package

conspack

Source

indexes.lisp (file)

Function: make-r-ref &key (VALUE VALUE)
Package

conspack

Source

r-ref.lisp (file)

Function: make-ref-context &key (MAX-ID MAX-ID) (OBJ-TO-ID OBJ-TO-ID) (ID-TO-OBJ ID-TO-OBJ) (FORWARD-REFS FORWARD-REFS) (NOTICED-OBJECTS NOTICED-OBJECTS) (WRITTEN-OBJECTS WRITTEN-OBJECTS) (ENCODED-OBJECTS ENCODED-OBJECTS)
Package

conspack

Source

reftable.lisp (file)

Function: pointer VALUE &optional BIT-WIDTH
Package

conspack

Source

encode.lisp (file)

Function: pointer-value INSTANCE
Function: (setf pointer-value) VALUE INSTANCE
Package

conspack

Source

encode.lisp (file)

Function: properties OBJECT
Package

conspack

Source

properties.lisp (file)

Function: property OBJECT TAG &optional DEFAULT
Function: (setf property) V OBJECT TAG
Package

conspack

Source

properties.lisp (file)

Function: r-ref VALUE
Package

conspack

Source

r-ref.lisp (file)

Function: remove-properties OBJECT
Package

conspack

Source

properties.lisp (file)

Function: remove-property OBJECT TAG
Package

conspack

Source

properties.lisp (file)


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

5.1.4 Generic functions

Generic Function: conspack-error-reason CONDITION
Package

conspack

Methods
Method: conspack-error-reason (CONDITION conspack-error)
Source

types.lisp (file)

Generic Function: conspack-error-value CONDITION
Package

conspack

Methods
Method: conspack-error-value (CONDITION conspack-error)
Source

types.lisp (file)

Generic Function: decode-object CLASS ALIST &key &allow-other-keys

Take the values in ‘ALIST‘ and recreate the object
of the given ‘CLASS‘. Methods should specialize on ‘CLASS (EQL symbol)‘.

Package

conspack

Source

tmap.lisp (file)

Generic Function: encode-object OBJECT &key &allow-other-keys

Return an alist for ‘OBJECT‘ which will be used for
key-value pairs for a Typed Map (tmap). The class of ‘OBJECT‘ will be encoded along with these and used by ‘DECODE-OBJECT‘ to recreate the object.

Package

conspack

Source

tmap.lisp (file)


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

5.1.5 Conditions

Condition: conspack-error ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods
Direct slots
Slot: value
Initargs

:value

Readers

conspack-error-value (generic function)

Slot: reason
Initargs

:reason

Readers

conspack-error-reason (generic function)

Condition: duplicate-id ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Direct methods
Direct slots
Slot: existing-value
Initargs

:existing-value

Readers

duplicate-ref-existing-value (generic function)

Slot: new-value
Initargs

:new-value

Readers

duplicate-ref-new-value (generic function)

Condition: invalid-header ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Condition: invalid-index ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Condition: invalid-package-name ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Condition: invalid-symbol-name ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Condition: invalid-symbol-package ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Condition: invalid-tmap-type ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Condition: unhandled-remote-reference ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)


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

5.1.6 Structures

Structure: pointer ()
Package

conspack

Source

encode.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots
Slot: value
Initform

0

Readers

pointer-value (function)

Writers

(setf pointer-value) (function)

Slot: bit-width
Readers

pointer-bit-width (function)

Writers

(setf pointer-bit-width) (function)

Structure: r-ref ()
Package

conspack

Source

r-ref.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: value
Readers

r-ref-value (function)

Writers

(setf r-ref-value) (function)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: +boolean-header+
Package

conspack

Source

headers.lisp (file)

Constant: +character-header+
Package

conspack

Source

headers.lisp (file)

Constant: +complex+
Package

conspack

Source

headers.lisp (file)

Constant: +cons-header+
Package

conspack

Source

headers.lisp (file)

Constant: +container-fixed+
Package

conspack

Source

headers.lisp (file)

Constant: +container-header+
Package

conspack

Source

headers.lisp (file)

Constant: +container-list+
Package

conspack

Source

headers.lisp (file)

Constant: +container-map+
Package

conspack

Source

headers.lisp (file)

Constant: +container-tmap+
Package

conspack

Source

headers.lisp (file)

Constant: +container-vector+
Package

conspack

Source

headers.lisp (file)

Constant: +double-float+
Package

conspack

Source

headers.lisp (file)

Constant: +index-header+
Package

conspack

Source

headers.lisp (file)

Constant: +int128+
Package

conspack

Source

headers.lisp (file)

Constant: +int16+
Package

conspack

Source

headers.lisp (file)

Constant: +int32+
Package

conspack

Source

headers.lisp (file)

Constant: +int64+
Package

conspack

Source

headers.lisp (file)

Constant: +int8+
Package

conspack

Source

headers.lisp (file)

Constant: +number-header+
Package

conspack

Source

headers.lisp (file)

Constant: +package-header+
Package

conspack

Source

headers.lisp (file)

Constant: +platform-bytes+
Package

conspack

Source

secure.lisp (file)

Constant: +pointer-header+
Package

conspack

Source

headers.lisp (file)

Constant: +properties-header+
Package

conspack

Source

headers.lisp (file)

Constant: +r-ref-header+
Package

conspack

Source

headers.lisp (file)

Constant: +rational+
Package

conspack

Source

headers.lisp (file)

Constant: +ref-header+
Package

conspack

Source

headers.lisp (file)

Constant: +reftag-inline+
Package

conspack

Source

headers.lisp (file)

Constant: +single-float+
Package

conspack

Source

headers.lisp (file)

Constant: +string-header+
Package

conspack

Source

headers.lisp (file)

Constant: +symbol-header+
Package

conspack

Source

headers.lisp (file)

Constant: +symbol-keyword+
Package

conspack

Source

headers.lisp (file)

Constant: +tag-header+
Package

conspack

Source

headers.lisp (file)

Constant: +uint128+
Package

conspack

Source

headers.lisp (file)

Constant: +uint16+
Package

conspack

Source

headers.lisp (file)

Constant: +uint32+
Package

conspack

Source

headers.lisp (file)

Constant: +uint64+
Package

conspack

Source

headers.lisp (file)

Constant: +uint8+
Package

conspack

Source

headers.lisp (file)


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

5.2.2 Special variables

Special Variable: *bytes-alloc*
Package

conspack

Source

secure.lisp (file)

Special Variable: *conspack-security*
Package

conspack

Source

secure.lisp (file)

Special Variable: *explain-eof*
Package

conspack

Source

explain.lisp (file)

Special Variable: *index*
Package

conspack

Source

indexes.lisp (file)

Special Variable: *indexes*
Package

conspack

Source

indexes.lisp (file)

Special Variable: *intern-symbols*
Package

conspack

Source

decode.lisp (file)

Special Variable: *properties*

Object => PLIST association for Properties. Setting a property and encoding will encode that property. Decoded properties will be included here as well.

Package

conspack

Source

properties.lisp (file)

Special Variable: *ref-context*
Package

conspack

Source

reftable.lisp (file)

Special Variable: *remote-ref-fun*
Package

conspack

Source

r-ref.lisp (file)


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

5.2.3 Macros

Macro: explaining-errors &body BODY
Package

conspack

Source

explain.lisp (file)


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

5.2.4 Functions

Function: %encode VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: %make-symbol-index &key (SYM->ID SYM->ID) (ID->SYM ID->SYM)
Package

conspack

Source

indexes.lisp (file)

Function: %properties-encode VALUE BUFFER
Package

conspack

Source

encode.lisp (file)

Function: add-forward-ref ID &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: add-ref ID OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: aval AKEY ALIST &key KEY TEST

Get the value for key ‘KEY‘ in ‘ALIST‘

Package

conspack

Source

util.lisp (file)

Function: bits-size-type BITS
Package

conspack

Source

headers.lisp (file)

Function: boolean-p N
Package

conspack

Source

headers.lisp (file)

Function: character-header C
Package

conspack

Source

headers.lisp (file)

Function: character-p N
Package

conspack

Source

headers.lisp (file)

Function: cons-p N
Package

conspack

Source

headers.lisp (file)

Function: container-fixed-p N
Package

conspack

Source

headers.lisp (file)

Function: container-header TYPE FIXED-P
Package

conspack

Source

headers.lisp (file)

Function: container-p N
Package

conspack

Source

headers.lisp (file)

Function: container-precheck-bytes LEN FIXED-HEADER
Package

conspack

Source

secure.lisp (file)

Function: container-type TYPE
Package

conspack

Source

headers.lisp (file)

Function: copy-forward-ref INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: copy-pointer INSTANCE
Package

conspack

Source

encode.lisp (file)

Function: copy-r-ref INSTANCE
Package

conspack

Source

r-ref.lisp (file)

Function: copy-ref-context INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: copy-symbol-index INSTANCE
Package

conspack

Source

indexes.lisp (file)

Function: decode-boolean HEADER
Package

conspack

Source

decode.lisp (file)

Function: decode-character HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-cons HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-container HEADER BUFFER &optional LEN
Package

conspack

Source

decode.lisp (file)

Function: decode-container-type HEADER
Package

conspack

Source

headers.lisp (file)

Function: decode-header H
Package

conspack

Source

headers.lisp (file)

Function: decode-index HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-list HEADER BUFFER &optional LEN
Package

conspack

Source

decode.lisp (file)

Function: decode-map HEADER BUFFER &optional LEN
Package

conspack

Source

decode.lisp (file)

Function: decode-number HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-number-header H
Package

conspack

Source

headers.lisp (file)

Function: decode-package HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-pointer HEADER BUFFER &optional LEN
Package

conspack

Source

decode.lisp (file)

Function: decode-properties HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-r-ref HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-ref HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-ref-id HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-size BYTES BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-string HEADER BUFFER &optional LEN
Package

conspack

Source

decode.lisp (file)

Function: decode-symbol HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-tag HEADER BUFFER
Package

conspack

Source

decode.lisp (file)

Function: decode-tmap HEADER BUFFER &optional LEN
Package

conspack

Source

decode.lisp (file)

Function: decode-value-or-fref BUFFER TYPE REF DATUM &optional HEADER
Package

conspack

Source

decode.lisp (file)

Function: decode-vector HEADER BUFFER &optional LEN
Package

conspack

Source

decode.lisp (file)

Function: encode-boolean VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-character VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-cons VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-hash VALUE BUFFER &optional FIXED-HEADER FIXED-TYPE
Package

conspack

Source

encode.lisp (file)

Function: encode-header HEADER-BYTE BUFFER &optional FIXED-HEADER SIZE-VALUE SIZE-TYPE

Combine ‘VALUES‘ with LOGIOR and write.

Package

conspack

Source

encode.lisp (file)

Function: encode-index VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-length SIZE-TYPE LEN BUFFER
Package

conspack

Source

encode.lisp (file)

Function: encode-list VALUE BUFFER &optional FIXED-HEADER FIXED-TYPE
Package

conspack

Source

encode.lisp (file)

Function: encode-number VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-package VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-pointer VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-properties VALUE BUFFER
Package

conspack

Source

encode.lisp (file)

Function: encode-r-ref VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-ref VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-ref-or-value VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-sequence VALUE BUFFER &optional FIXED-HEADER FIXED-TYPE
Package

conspack

Source

encode.lisp (file)

Function: encode-string VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-symbol VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-tag VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-tmap VALUE BUFFER &optional FIXED-HEADER
Package

conspack

Source

encode.lisp (file)

Function: encode-vector VALUE BUFFER &optional FIXED-HEADER FIXED-TYPE
Package

conspack

Source

encode.lisp (file)

Function: explain-buffer BUFFER &optional N FIXED-HEADER

This will try and find and interpret as many bytes as possible, up to ‘N‘ objects, or until end-of-file, if ‘N‘ is ‘nil‘.

Package

conspack

Source

explain.lisp (file)

Function: explain-container BUFFER HEADER
Package

conspack

Source

explain.lisp (file)

Function: find-fixed-type TYPE
Package

conspack

Source

headers.lisp (file)

Function: find-index NAME
Package

conspack

Source

indexes.lisp (file)

Function: forward-ref-datum INSTANCE
Function: (setf forward-ref-datum) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: forward-ref-p OBJECT
Package

conspack

Source

reftable.lisp (file)

Function: forward-ref-ref INSTANCE
Function: (setf forward-ref-ref) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: forward-ref-type INSTANCE
Function: (setf forward-ref-type) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: get-ref ID &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: get-ref-id OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: index-p N
Package

conspack

Source

headers.lisp (file)

Function: keyword-p N
Package

conspack

Source

headers.lisp (file)

Function: len-size-type LEN
Package

conspack

Source

headers.lisp (file)

Function: list-length-with-refs LIST &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: make-forward-ref &key (TYPE TYPE) (REF REF) (DATUM DATUM)
Package

conspack

Source

reftable.lisp (file)

Function: make-pointer &key (VALUE VALUE) (BIT-WIDTH BIT-WIDTH)
Package

conspack

Source

encode.lisp (file)

Function: make-symbol-index LEN
Package

conspack

Source

indexes.lisp (file)

Function: notice-object OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: notice-recursively OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: noticed-p OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: number-header TYPE
Package

conspack

Source

headers.lisp (file)

Function: number-p N
Package

conspack

Source

headers.lisp (file)

Function: number-size H
Package

conspack

Source

headers.lisp (file)

Function: number-type NUMBER

Find the closest/smallest encoding type for NUMBER.

Package

conspack

Source

headers.lisp (file)

Function: number-type-to-lisp TYPE

Find the lisp type (e.g., SINGLE-FLOAT) for a specified number type (e.g., :SINGLE-FLOAT). The inverse of NUMBER-TYPE.

Package

conspack

Source

headers.lisp (file)

Function: package-p N
Package

conspack

Source

headers.lisp (file)

Function: pointer-bit-width INSTANCE
Function: (setf pointer-bit-width) VALUE INSTANCE
Package

conspack

Source

encode.lisp (file)

Function: pointer-header-p N
Package

conspack

Source

headers.lisp (file)

Function: pointer-p OBJECT
Package

conspack

Source

encode.lisp (file)

Function: precheck-bytes N &optional TIMES
Package

conspack

Source

secure.lisp (file)

Function: properties-p N
Package

conspack

Source

headers.lisp (file)

Function: r-ref-p OBJECT
Package

conspack

Source

r-ref.lisp (file)

Function: r-ref-value INSTANCE
Function: (setf r-ref-value) VALUE INSTANCE
Package

conspack

Source

r-ref.lisp (file)

Function: ref-context-encoded-objects INSTANCE
Function: (setf ref-context-encoded-objects) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: ref-context-forward-refs INSTANCE
Function: (setf ref-context-forward-refs) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: ref-context-id-to-obj INSTANCE
Function: (setf ref-context-id-to-obj) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: ref-context-max-id INSTANCE
Function: (setf ref-context-max-id) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: ref-context-noticed-objects INSTANCE
Function: (setf ref-context-noticed-objects) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: ref-context-obj-to-id INSTANCE
Function: (setf ref-context-obj-to-id) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: ref-context-p OBJECT
Package

conspack

Source

reftable.lisp (file)

Function: ref-context-written-objects INSTANCE
Function: (setf ref-context-written-objects) VALUE INSTANCE
Package

conspack

Source

reftable.lisp (file)

Function: ref-p N
Package

conspack

Source

headers.lisp (file)

Function: referrable-p OBJECT
Package

conspack

Source

reftable.lisp (file)

Function: remote-ref-p N
Package

conspack

Source

headers.lisp (file)

Function: replace-forward-ref FORWARD-REF OBJECT
Package

conspack

Source

reftable.lisp (file)

Function: replace-forward-refs ID OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: size-bytes HEADER
Package

conspack

Source

headers.lisp (file)

Function: size-type HEADER
Package

conspack

Source

headers.lisp (file)

Function: string-p N
Package

conspack

Source

headers.lisp (file)

Function: symbol-header VALUE
Package

conspack

Source

headers.lisp (file)

Function: symbol-index-id->sym INSTANCE
Function: (setf symbol-index-id->sym) VALUE INSTANCE
Package

conspack

Source

indexes.lisp (file)

Function: symbol-index-p OBJECT
Package

conspack

Source

indexes.lisp (file)

Function: symbol-index-sym->id INSTANCE
Function: (setf symbol-index-sym->id) VALUE INSTANCE
Package

conspack

Source

indexes.lisp (file)

Function: symbol-p N
Package

conspack

Source

headers.lisp (file)

Function: tag-inline-p N
Package

conspack

Source

headers.lisp (file)

Function: tag-object OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: tag-p N
Package

conspack

Source

headers.lisp (file)

Function: tracking-refs-p ()
Package

conspack

Source

reftable.lisp (file)

Function: trivial-p OBJECT
Package

conspack

Source

reftable.lisp (file)

Function: type-header TYPE
Package

conspack

Source

headers.lisp (file)

Function: use-bytes N &optional TIMES
Package

conspack

Source

secure.lisp (file)

Function: written-p OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)

Function: wrote OBJECT &optional CONTEXT
Package

conspack

Source

reftable.lisp (file)


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

5.2.5 Generic functions

Generic Function: duplicate-ref-existing-value CONDITION
Package

conspack

Methods
Method: duplicate-ref-existing-value (CONDITION duplicate-id)
Source

types.lisp (file)

Generic Function: duplicate-ref-new-value CONDITION
Package

conspack

Methods
Method: duplicate-ref-new-value (CONDITION duplicate-id)
Source

types.lisp (file)


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

5.2.6 Conditions

Condition: invalid-forward-ref ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

security-error (condition)

Condition: invalid-size ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Condition: max-size-exceeded ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

security-error (condition)

Condition: security-error ()
Package

conspack

Source

types.lisp (file)

Direct superclasses

conspack-error (condition)

Direct subclasses

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

5.2.7 Structures

Structure: forward-ref ()
Package

conspack

Source

reftable.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: type
Type

symbol

Readers

forward-ref-type (function)

Writers

(setf forward-ref-type) (function)

Slot: ref
Readers

forward-ref-ref (function)

Writers

(setf forward-ref-ref) (function)

Slot: datum
Readers

forward-ref-datum (function)

Writers

(setf forward-ref-datum) (function)

Structure: ref-context ()
Package

conspack

Source

reftable.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: max-id
Type

(unsigned-byte 32)

Initform

0

Readers

ref-context-max-id (function)

Writers

(setf ref-context-max-id) (function)

Slot: obj-to-id
Initform

(make-hash-table)

Readers

ref-context-obj-to-id (function)

Writers

(setf ref-context-obj-to-id) (function)

Slot: id-to-obj
Initform

(make-hash-table)

Readers

ref-context-id-to-obj (function)

Writers

(setf ref-context-id-to-obj) (function)

Slot: forward-refs
Initform

(make-hash-table)

Readers

ref-context-forward-refs (function)

Writers

(setf ref-context-forward-refs) (function)

Slot: noticed-objects
Initform

(make-hash-table)

Readers

ref-context-noticed-objects (function)

Writers

(setf ref-context-noticed-objects) (function)

Slot: written-objects
Initform

(make-hash-table)

Readers

ref-context-written-objects (function)

Writers

(setf ref-context-written-objects) (function)

Slot: encoded-objects
Initform

(make-hash-table)

Readers

ref-context-encoded-objects (function)

Writers

(setf ref-context-encoded-objects) (function)

Structure: symbol-index ()
Package

conspack

Source

indexes.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

make-load-form (method)

Direct slots
Slot: sym->id
Type

hash-table

Readers

symbol-index-sym->id (function)

Writers

(setf symbol-index-sym->id) (function)

Slot: id->sym
Type

vector

Readers

symbol-index-id->sym (function)

Writers

(setf symbol-index-id->sym) (function)


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

5.2.8 Types

Type: header ()
Package

conspack

Source

types.lisp (file)

Type: header-decode-fun ()
Package

conspack

Source

types.lisp (file)

Type: header-test-fun ()
Package

conspack

Source

types.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-conspack.asd: The cl-conspack<dot>asd file
cl-conspack/decode.lisp: The cl-conspack/decode<dot>lisp file
cl-conspack/encode.lisp: The cl-conspack/encode<dot>lisp file
cl-conspack/explain.lisp: The cl-conspack/explain<dot>lisp file
cl-conspack/headers.lisp: The cl-conspack/headers<dot>lisp file
cl-conspack/indexes.lisp: The cl-conspack/indexes<dot>lisp file
cl-conspack/package.lisp: The cl-conspack/package<dot>lisp file
cl-conspack/properties.lisp: The cl-conspack/properties<dot>lisp file
cl-conspack/r-ref.lisp: The cl-conspack/r-ref<dot>lisp file
cl-conspack/reftable.lisp: The cl-conspack/reftable<dot>lisp file
cl-conspack/secure.lisp: The cl-conspack/secure<dot>lisp file
cl-conspack/tmap.lisp: The cl-conspack/tmap<dot>lisp file
cl-conspack/types.lisp: The cl-conspack/types<dot>lisp file
cl-conspack/util.lisp: The cl-conspack/util<dot>lisp file

F
File, Lisp, cl-conspack.asd: The cl-conspack<dot>asd file
File, Lisp, cl-conspack/decode.lisp: The cl-conspack/decode<dot>lisp file
File, Lisp, cl-conspack/encode.lisp: The cl-conspack/encode<dot>lisp file
File, Lisp, cl-conspack/explain.lisp: The cl-conspack/explain<dot>lisp file
File, Lisp, cl-conspack/headers.lisp: The cl-conspack/headers<dot>lisp file
File, Lisp, cl-conspack/indexes.lisp: The cl-conspack/indexes<dot>lisp file
File, Lisp, cl-conspack/package.lisp: The cl-conspack/package<dot>lisp file
File, Lisp, cl-conspack/properties.lisp: The cl-conspack/properties<dot>lisp file
File, Lisp, cl-conspack/r-ref.lisp: The cl-conspack/r-ref<dot>lisp file
File, Lisp, cl-conspack/reftable.lisp: The cl-conspack/reftable<dot>lisp file
File, Lisp, cl-conspack/secure.lisp: The cl-conspack/secure<dot>lisp file
File, Lisp, cl-conspack/tmap.lisp: The cl-conspack/tmap<dot>lisp file
File, Lisp, cl-conspack/types.lisp: The cl-conspack/types<dot>lisp file
File, Lisp, cl-conspack/util.lisp: The cl-conspack/util<dot>lisp file

L
Lisp File, cl-conspack.asd: The cl-conspack<dot>asd file
Lisp File, cl-conspack/decode.lisp: The cl-conspack/decode<dot>lisp file
Lisp File, cl-conspack/encode.lisp: The cl-conspack/encode<dot>lisp file
Lisp File, cl-conspack/explain.lisp: The cl-conspack/explain<dot>lisp file
Lisp File, cl-conspack/headers.lisp: The cl-conspack/headers<dot>lisp file
Lisp File, cl-conspack/indexes.lisp: The cl-conspack/indexes<dot>lisp file
Lisp File, cl-conspack/package.lisp: The cl-conspack/package<dot>lisp file
Lisp File, cl-conspack/properties.lisp: The cl-conspack/properties<dot>lisp file
Lisp File, cl-conspack/r-ref.lisp: The cl-conspack/r-ref<dot>lisp file
Lisp File, cl-conspack/reftable.lisp: The cl-conspack/reftable<dot>lisp file
Lisp File, cl-conspack/secure.lisp: The cl-conspack/secure<dot>lisp file
Lisp File, cl-conspack/tmap.lisp: The cl-conspack/tmap<dot>lisp file
Lisp File, cl-conspack/types.lisp: The cl-conspack/types<dot>lisp file
Lisp File, cl-conspack/util.lisp: The cl-conspack/util<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   I   K   L   M   N   P   R   S   T   U   W  
Index Entry  Section

%
%encode: Internal functions
%make-symbol-index: Internal functions
%properties-encode: Internal functions

(
(setf forward-ref-datum): Internal functions
(setf forward-ref-ref): Internal functions
(setf forward-ref-type): Internal functions
(setf pointer-bit-width): Internal functions
(setf pointer-value): Exported functions
(setf property): Exported functions
(setf r-ref-value): Internal functions
(setf ref-context-encoded-objects): Internal functions
(setf ref-context-forward-refs): Internal functions
(setf ref-context-id-to-obj): Internal functions
(setf ref-context-max-id): Internal functions
(setf ref-context-noticed-objects): Internal functions
(setf ref-context-obj-to-id): Internal functions
(setf ref-context-written-objects): Internal functions
(setf symbol-index-id->sym): Internal functions
(setf symbol-index-sym->id): Internal functions

A
add-forward-ref: Internal functions
add-ref: Internal functions
alist-to-slots: Exported macros
aval: Internal functions

B
bits-size-type: Internal functions
boolean-p: Internal functions

C
character-header: Internal functions
character-p: Internal functions
clear-refs: Exported functions
cons-p: Internal functions
conspack-error-reason: Exported generic functions
conspack-error-reason: Exported generic functions
conspack-error-value: Exported generic functions
conspack-error-value: Exported generic functions
container-fixed-p: Internal functions
container-header: Internal functions
container-p: Internal functions
container-precheck-bytes: Internal functions
container-type: Internal functions
copy-forward-ref: Internal functions
copy-pointer: Internal functions
copy-r-ref: Internal functions
copy-ref-context: Internal functions
copy-symbol-index: Internal functions

D
decode: Exported functions
decode-boolean: Internal functions
decode-character: Internal functions
decode-cons: Internal functions
decode-container: Internal functions
decode-container-type: Internal functions
decode-file: Exported functions
decode-header: Internal functions
decode-index: Internal functions
decode-list: Internal functions
decode-map: Internal functions
decode-number: Internal functions
decode-number-header: Internal functions
decode-object: Exported generic functions
decode-package: Internal functions
decode-pointer: Internal functions
decode-properties: Internal functions
decode-r-ref: Internal functions
decode-ref: Internal functions
decode-ref-id: Internal functions
decode-size: Internal functions
decode-stream: Exported functions
decode-string: Internal functions
decode-symbol: Internal functions
decode-tag: Internal functions
decode-tmap: Internal functions
decode-value: Exported functions
decode-value-or-fref: Internal functions
decode-vector: Internal functions
defencoding: Exported macros
define-index: Exported macros
delete-index: Exported functions
duplicate-ref-existing-value: Internal generic functions
duplicate-ref-existing-value: Internal generic functions
duplicate-ref-new-value: Internal generic functions
duplicate-ref-new-value: Internal generic functions

E
encode: Exported functions
encode-boolean: Internal functions
encode-character: Internal functions
encode-cons: Internal functions
encode-hash: Internal functions
encode-header: Internal functions
encode-index: Internal functions
encode-length: Internal functions
encode-list: Internal functions
encode-number: Internal functions
encode-object: Exported generic functions
encode-package: Internal functions
encode-pointer: Internal functions
encode-properties: Internal functions
encode-r-ref: Internal functions
encode-ref: Internal functions
encode-ref-or-value: Internal functions
encode-sequence: Internal functions
encode-string: Internal functions
encode-symbol: Internal functions
encode-tag: Internal functions
encode-tmap: Internal functions
encode-to-buffer: Exported functions
encode-to-file: Exported functions
encode-vector: Internal functions
explain: Exported functions
explain-buffer: Internal functions
explain-container: Internal functions
explaining-errors: Internal macros

F
find-fixed-type: Internal functions
find-in-index: Exported functions
find-index: Internal functions
forward-ref-datum: Internal functions
forward-ref-p: Internal functions
forward-ref-ref: Internal functions
forward-ref-type: Internal functions
Function, %encode: Internal functions
Function, %make-symbol-index: Internal functions
Function, %properties-encode: Internal functions
Function, (setf forward-ref-datum): Internal functions
Function, (setf forward-ref-ref): Internal functions
Function, (setf forward-ref-type): Internal functions
Function, (setf pointer-bit-width): Internal functions
Function, (setf pointer-value): Exported functions
Function, (setf property): Exported functions
Function, (setf r-ref-value): Internal functions
Function, (setf ref-context-encoded-objects): Internal functions
Function, (setf ref-context-forward-refs): Internal functions
Function, (setf ref-context-id-to-obj): Internal functions
Function, (setf ref-context-max-id): Internal functions
Function, (setf ref-context-noticed-objects): Internal functions
Function, (setf ref-context-obj-to-id): Internal functions
Function, (setf ref-context-written-objects): Internal functions
Function, (setf symbol-index-id->sym): Internal functions
Function, (setf symbol-index-sym->id): Internal functions
Function, add-forward-ref: Internal functions
Function, add-ref: Internal functions
Function, aval: Internal functions
Function, bits-size-type: Internal functions
Function, boolean-p: Internal functions
Function, character-header: Internal functions
Function, character-p: Internal functions
Function, clear-refs: Exported functions
Function, cons-p: Internal functions
Function, container-fixed-p: Internal functions
Function, container-header: Internal functions
Function, container-p: Internal functions
Function, container-precheck-bytes: Internal functions
Function, container-type: Internal functions
Function, copy-forward-ref: Internal functions
Function, copy-pointer: Internal functions
Function, copy-r-ref: Internal functions
Function, copy-ref-context: Internal functions
Function, copy-symbol-index: Internal functions
Function, decode: Exported functions
Function, decode-boolean: Internal functions
Function, decode-character: Internal functions
Function, decode-cons: Internal functions
Function, decode-container: Internal functions
Function, decode-container-type: Internal functions
Function, decode-file: Exported functions
Function, decode-header: Internal functions
Function, decode-index: Internal functions
Function, decode-list: Internal functions
Function, decode-map: Internal functions
Function, decode-number: Internal functions
Function, decode-number-header: Internal functions
Function, decode-package: Internal functions
Function, decode-pointer: Internal functions
Function, decode-properties: Internal functions
Function, decode-r-ref: Internal functions
Function, decode-ref: Internal functions
Function, decode-ref-id: Internal functions
Function, decode-size: Internal functions
Function, decode-stream: Exported functions
Function, decode-string: Internal functions
Function, decode-symbol: Internal functions
Function, decode-tag: Internal functions
Function, decode-tmap: Internal functions
Function, decode-value: Exported functions
Function, decode-value-or-fref: Internal functions
Function, decode-vector: Internal functions
Function, delete-index: Exported functions
Function, encode: Exported functions
Function, encode-boolean: Internal functions
Function, encode-character: Internal functions
Function, encode-cons: Internal functions
Function, encode-hash: Internal functions
Function, encode-header: Internal functions
Function, encode-index: Internal functions
Function, encode-length: Internal functions
Function, encode-list: Internal functions
Function, encode-number: Internal functions
Function, encode-package: Internal functions
Function, encode-pointer: Internal functions
Function, encode-properties: Internal functions
Function, encode-r-ref: Internal functions
Function, encode-ref: Internal functions
Function, encode-ref-or-value: Internal functions
Function, encode-sequence: Internal functions
Function, encode-string: Internal functions
Function, encode-symbol: Internal functions
Function, encode-tag: Internal functions
Function, encode-tmap: Internal functions
Function, encode-to-buffer: Exported functions
Function, encode-to-file: Exported functions
Function, encode-vector: Internal functions
Function, explain: Exported functions
Function, explain-buffer: Internal functions
Function, explain-container: Internal functions
Function, find-fixed-type: Internal functions
Function, find-in-index: Exported functions
Function, find-index: Internal functions
Function, forward-ref-datum: Internal functions
Function, forward-ref-p: Internal functions
Function, forward-ref-ref: Internal functions
Function, forward-ref-type: Internal functions
Function, get-ref: Internal functions
Function, get-ref-id: Internal functions
Function, index-p: Internal functions
Function, keyword-p: Internal functions
Function, len-size-type: Internal functions
Function, list-length-with-refs: Internal functions
Function, make-forward-ref: Internal functions
Function, make-index: Exported functions
Function, make-pointer: Internal functions
Function, make-r-ref: Exported functions
Function, make-ref-context: Exported functions
Function, make-symbol-index: Internal functions
Function, notice-object: Internal functions
Function, notice-recursively: Internal functions
Function, noticed-p: Internal functions
Function, number-header: Internal functions
Function, number-p: Internal functions
Function, number-size: Internal functions
Function, number-type: Internal functions
Function, number-type-to-lisp: Internal functions
Function, package-p: Internal functions
Function, pointer: Exported functions
Function, pointer-bit-width: Internal functions
Function, pointer-header-p: Internal functions
Function, pointer-p: Internal functions
Function, pointer-value: Exported functions
Function, precheck-bytes: Internal functions
Function, properties: Exported functions
Function, properties-p: Internal functions
Function, property: Exported functions
Function, r-ref: Exported functions
Function, r-ref-p: Internal functions
Function, r-ref-value: Internal functions
Function, ref-context-encoded-objects: Internal functions
Function, ref-context-forward-refs: Internal functions
Function, ref-context-id-to-obj: Internal functions
Function, ref-context-max-id: Internal functions
Function, ref-context-noticed-objects: Internal functions
Function, ref-context-obj-to-id: Internal functions
Function, ref-context-p: Internal functions
Function, ref-context-written-objects: Internal functions
Function, ref-p: Internal functions
Function, referrable-p: Internal functions
Function, remote-ref-p: Internal functions
Function, remove-properties: Exported functions
Function, remove-property: Exported functions
Function, replace-forward-ref: Internal functions
Function, replace-forward-refs: Internal functions
Function, size-bytes: Internal functions
Function, size-type: Internal functions
Function, string-p: Internal functions
Function, symbol-header: Internal functions
Function, symbol-index-id->sym: Internal functions
Function, symbol-index-p: Internal functions
Function, symbol-index-sym->id: Internal functions
Function, symbol-p: Internal functions
Function, tag-inline-p: Internal functions
Function, tag-object: Internal functions
Function, tag-p: Internal functions
Function, tracking-refs-p: Internal functions
Function, trivial-p: Internal functions
Function, type-header: Internal functions
Function, use-bytes: Internal functions
Function, written-p: Internal functions
Function, wrote: Internal functions

G
Generic Function, conspack-error-reason: Exported generic functions
Generic Function, conspack-error-value: Exported generic functions
Generic Function, decode-object: Exported generic functions
Generic Function, duplicate-ref-existing-value: Internal generic functions
Generic Function, duplicate-ref-new-value: Internal generic functions
Generic Function, encode-object: Exported generic functions
get-ref: Internal functions
get-ref-id: Internal functions

I
index-p: Internal functions

K
keyword-p: Internal functions

L
len-size-type: Internal functions
list-length-with-refs: Internal functions

M
Macro, alist-to-slots: Exported macros
Macro, defencoding: Exported macros
Macro, define-index: Exported macros
Macro, explaining-errors: Internal macros
Macro, slots-to-alist: Exported macros
Macro, tracking-refs: Exported macros
Macro, with-conspack-security: Exported macros
Macro, with-index: Exported macros
Macro, with-interning: Exported macros
Macro, with-named-index: Exported macros
Macro, with-properties: Exported macros
Macro, with-remote-refs: Exported macros
make-forward-ref: Internal functions
make-index: Exported functions
make-pointer: Internal functions
make-r-ref: Exported functions
make-ref-context: Exported functions
make-symbol-index: Internal functions
Method, conspack-error-reason: Exported generic functions
Method, conspack-error-value: Exported generic functions
Method, duplicate-ref-existing-value: Internal generic functions
Method, duplicate-ref-new-value: Internal generic functions

N
notice-object: Internal functions
notice-recursively: Internal functions
noticed-p: Internal functions
number-header: Internal functions
number-p: Internal functions
number-size: Internal functions
number-type: Internal functions
number-type-to-lisp: Internal functions

P
package-p: Internal functions
pointer: Exported functions
pointer-bit-width: Internal functions
pointer-header-p: Internal functions
pointer-p: Internal functions
pointer-value: Exported functions
precheck-bytes: Internal functions
properties: Exported functions
properties-p: Internal functions
property: Exported functions

R
r-ref: Exported functions
r-ref-p: Internal functions
r-ref-value: Internal functions
ref-context-encoded-objects: Internal functions
ref-context-forward-refs: Internal functions
ref-context-id-to-obj: Internal functions
ref-context-max-id: Internal functions
ref-context-noticed-objects: Internal functions
ref-context-obj-to-id: Internal functions
ref-context-p: Internal functions
ref-context-written-objects: Internal functions
ref-p: Internal functions
referrable-p: Internal functions
remote-ref-p: Internal functions
remove-properties: Exported functions
remove-property: Exported functions
replace-forward-ref: Internal functions
replace-forward-refs: Internal functions

S
size-bytes: Internal functions
size-type: Internal functions
slots-to-alist: Exported macros
string-p: Internal functions
symbol-header: Internal functions
symbol-index-id->sym: Internal functions
symbol-index-p: Internal functions
symbol-index-sym->id: Internal functions
symbol-p: Internal functions

T
tag-inline-p: Internal functions
tag-object: Internal functions
tag-p: Internal functions
tracking-refs: Exported macros
tracking-refs-p: Internal functions
trivial-p: Internal functions
type-header: Internal functions

U
use-bytes: Internal functions

W
with-conspack-security: Exported macros
with-index: Exported macros
with-interning: Exported macros
with-named-index: Exported macros
with-properties: Exported macros
with-remote-refs: Exported macros
written-p: Internal functions
wrote: Internal functions

Jump to:   %   (  
A   B   C   D   E   F   G   I   K   L   M   N   P   R   S   T   U   W  

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

A.3 Variables

Jump to:   *   +  
B   C   D   E   F   I   M   N   O   R   S   T   V   W  
Index Entry  Section

*
*bytes-alloc*: Internal special variables
*conspack-forward-refs*: Exported special variables
*conspack-max-bytes*: Exported special variables
*conspack-security*: Internal special variables
*current-properties*: Exported special variables
*explain-eof*: Internal special variables
*index*: Internal special variables
*indexes*: Internal special variables
*intern-symbols*: Internal special variables
*properties*: Internal special variables
*ref-context*: Internal special variables
*remote-ref-fun*: Internal special variables

+
+boolean-header+: Internal constants
+character-header+: Internal constants
+complex+: Internal constants
+cons-header+: Internal constants
+container-fixed+: Internal constants
+container-header+: Internal constants
+container-list+: Internal constants
+container-map+: Internal constants
+container-tmap+: Internal constants
+container-vector+: Internal constants
+double-float+: Internal constants
+index-header+: Internal constants
+int128+: Internal constants
+int16+: Internal constants
+int32+: Internal constants
+int64+: Internal constants
+int8+: Internal constants
+number-header+: Internal constants
+package-header+: Internal constants
+platform-bytes+: Internal constants
+pointer-header+: Internal constants
+properties-header+: Internal constants
+r-ref-header+: Internal constants
+rational+: Internal constants
+ref-header+: Internal constants
+reftag-inline+: Internal constants
+single-float+: Internal constants
+string-header+: Internal constants
+symbol-header+: Internal constants
+symbol-keyword+: Internal constants
+tag-header+: Internal constants
+uint128+: Internal constants
+uint16+: Internal constants
+uint32+: Internal constants
+uint64+: Internal constants
+uint8+: Internal constants

B
bit-width: Exported structures

C
Constant, +boolean-header+: Internal constants
Constant, +character-header+: Internal constants
Constant, +complex+: Internal constants
Constant, +cons-header+: Internal constants
Constant, +container-fixed+: Internal constants
Constant, +container-header+: Internal constants
Constant, +container-list+: Internal constants
Constant, +container-map+: Internal constants
Constant, +container-tmap+: Internal constants
Constant, +container-vector+: Internal constants
Constant, +double-float+: Internal constants
Constant, +index-header+: Internal constants
Constant, +int128+: Internal constants
Constant, +int16+: Internal constants
Constant, +int32+: Internal constants
Constant, +int64+: Internal constants
Constant, +int8+: Internal constants
Constant, +number-header+: Internal constants
Constant, +package-header+: Internal constants
Constant, +platform-bytes+: Internal constants
Constant, +pointer-header+: Internal constants
Constant, +properties-header+: Internal constants
Constant, +r-ref-header+: Internal constants
Constant, +rational+: Internal constants
Constant, +ref-header+: Internal constants
Constant, +reftag-inline+: Internal constants
Constant, +single-float+: Internal constants
Constant, +string-header+: Internal constants
Constant, +symbol-header+: Internal constants
Constant, +symbol-keyword+: Internal constants
Constant, +tag-header+: Internal constants
Constant, +uint128+: Internal constants
Constant, +uint16+: Internal constants
Constant, +uint32+: Internal constants
Constant, +uint64+: Internal constants
Constant, +uint8+: Internal constants

D
datum: Internal structures

E
encoded-objects: Internal structures
existing-value: Exported conditions

F
forward-refs: Internal structures

I
id->sym: Internal structures
id-to-obj: Internal structures

M
max-id: Internal structures

N
new-value: Exported conditions
noticed-objects: Internal structures

O
obj-to-id: Internal structures

R
reason: Exported conditions
ref: Internal structures

S
Slot, bit-width: Exported structures
Slot, datum: Internal structures
Slot, encoded-objects: Internal structures
Slot, existing-value: Exported conditions
Slot, forward-refs: Internal structures
Slot, id->sym: Internal structures
Slot, id-to-obj: Internal structures
Slot, max-id: Internal structures
Slot, new-value: Exported conditions
Slot, noticed-objects: Internal structures
Slot, obj-to-id: Internal structures
Slot, reason: Exported conditions
Slot, ref: Internal structures
Slot, sym->id: Internal structures
Slot, type: Internal structures
Slot, value: Exported conditions
Slot, value: Exported structures
Slot, value: Exported structures
Slot, written-objects: Internal structures
Special Variable, *bytes-alloc*: Internal special variables
Special Variable, *conspack-forward-refs*: Exported special variables
Special Variable, *conspack-max-bytes*: Exported special variables
Special Variable, *conspack-security*: Internal special variables
Special Variable, *current-properties*: Exported special variables
Special Variable, *explain-eof*: Internal special variables
Special Variable, *index*: Internal special variables
Special Variable, *indexes*: Internal special variables
Special Variable, *intern-symbols*: Internal special variables
Special Variable, *properties*: Internal special variables
Special Variable, *ref-context*: Internal special variables
Special Variable, *remote-ref-fun*: Internal special variables
sym->id: Internal structures

T
type: Internal structures

V
value: Exported conditions
value: Exported structures
value: Exported structures

W
written-objects: Internal structures

Jump to:   *   +  
B   C   D   E   F   I   M   N   O   R   S   T   V   W  

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

A.4 Data types

Jump to:   C   D   F   H   I   M   P   R   S   T   U  
Index Entry  Section

C
cl-conspack: The cl-conspack system
cl-conspack.asdf: The cl-conspack<dot>asdf package
Condition, conspack-error: Exported conditions
Condition, duplicate-id: Exported conditions
Condition, invalid-forward-ref: Internal conditions
Condition, invalid-header: Exported conditions
Condition, invalid-index: Exported conditions
Condition, invalid-package-name: Exported conditions
Condition, invalid-size: Internal conditions
Condition, invalid-symbol-name: Exported conditions
Condition, invalid-symbol-package: Exported conditions
Condition, invalid-tmap-type: Exported conditions
Condition, max-size-exceeded: Internal conditions
Condition, security-error: Internal conditions
Condition, unhandled-remote-reference: Exported conditions
conspack: The conspack package
conspack-error: Exported conditions

D
duplicate-id: Exported conditions

F
forward-ref: Internal structures

H
header: Internal types
header-decode-fun: Internal types
header-test-fun: Internal types

I
invalid-forward-ref: Internal conditions
invalid-header: Exported conditions
invalid-index: Exported conditions
invalid-package-name: Exported conditions
invalid-size: Internal conditions
invalid-symbol-name: Exported conditions
invalid-symbol-package: Exported conditions
invalid-tmap-type: Exported conditions

M
max-size-exceeded: Internal conditions

P
Package, cl-conspack.asdf: The cl-conspack<dot>asdf package
Package, conspack: The conspack package
pointer: Exported structures

R
r-ref: Exported structures
ref-context: Internal structures

S
security-error: Internal conditions
Structure, forward-ref: Internal structures
Structure, pointer: Exported structures
Structure, r-ref: Exported structures
Structure, ref-context: Internal structures
Structure, symbol-index: Internal structures
symbol-index: Internal structures
System, cl-conspack: The cl-conspack system

T
Type, header: Internal types
Type, header-decode-fun: Internal types
Type, header-test-fun: Internal types

U
unhandled-remote-reference: Exported conditions

Jump to:   C   D   F   H   I   M   P   R   S   T   U