This is the cl-store Reference Manual, version 0.8.11, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:50:50 2020 GMT+0.
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The cl-store system |
Sean Ross <sross@common-lisp.net>
Sean Ross <sross@common-lisp.net>
MIT
Serialization package
Portable CL Package to serialize data
0.8.11
cl-store.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The cl-store/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-store.asd
cl-store (system)
non-required-file (class)
lisp-system-shortname (function)
Next: The cl-store/utils․lisp file, Previous: The cl-store․asd file, Up: Lisp files [Contents][Index]
Next: The cl-store/backends․lisp file, Previous: The cl-store/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-store (system)
utils.lisp
Next: The cl-store/plumbing․lisp file, Previous: The cl-store/utils․lisp file, Up: Lisp files [Contents][Index]
utils.lisp (file)
cl-store (system)
backends.lisp
Next: The cl-store/circularities․lisp file, Previous: The cl-store/backends․lisp file, Up: Lisp files [Contents][Index]
backends.lisp (file)
cl-store (system)
plumbing.lisp
Next: The cl-store/default-backend․lisp file, Previous: The cl-store/plumbing․lisp file, Up: Lisp files [Contents][Index]
plumbing.lisp (file)
cl-store (system)
circularities.lisp
Next: The cl-store/custom․lisp file, Previous: The cl-store/circularities․lisp file, Up: Lisp files [Contents][Index]
circularities.lisp (file)
cl-store (system)
default-backend.lisp
Previous: The cl-store/default-backend․lisp file, Up: Lisp files [Contents][Index]
default-backend.lisp (file)
cl-store (system)
sbcl/custom.lisp
internal-store-object (method)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-store.system package | ||
• The cl-store package |
Next: The cl-store package, Previous: Packages, Up: Packages [Contents][Index]
cl-store.asd
non-required-file (class)
lisp-system-shortname (function)
Previous: The cl-store․system package, Up: Packages [Contents][Index]
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported classes |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
circularities.lisp (file)
plumbing.lisp (file)
plumbing.lisp (file)
circularities.lisp (file)
Do we overwrite existing class definitions on restoration.
plumbing.lisp (file)
Whether or not to overwrite existing packages on restoration.
plumbing.lisp (file)
When bound to true the precise list serializer will be used which will ensure that
all shared structure in a list will be serialized and deserialized correctly.
This method of storing lists, while more correct than the default, will NOT work with
large lists as it will blow the stack.
Binding this variable to true only affects storing and makes no difference when restoring lists.
default-backend.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
Whether or not to serialize slots which are class allocated.
plumbing.lisp (file)
Whether or not to store the superclasses of a stored class.
plumbing.lisp (file)
circularities.lisp (file)
If non-nil will serialize each used package otherwise will only store the package name
plumbing.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Defines a new backend called NAME. Stream type must be either ’char or ’binary.
FIELDS is a list of legal slots for defclass. MAGIC-NUMBER, when supplied, will
be written down stream as verification and checked on restoration.
EXTENDS is a class to extend, which must be backend or a class which extends
backend
backends.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
Execute body attempting to resolve circularities found in form CREATE.
circularities.lisp (file)
Resolve the possible referring object retrieved by GET and set it into PLACE. Only usable within a resolving-object form.
circularities.lisp (file)
Insert the value retrieved by GETTING-VALUE with the key retrieved by GETTING-KEY, resolving possible circularities. Only usable within a resolving-object form.
circularities.lisp (file)
Run BODY with *default-backend* bound to BACKEND
backends.lisp (file)
Executes body in a single serialization unit allowing various internal data
structures to be reused.
The keys store-hash and restore-hash are expected to be either nil or
hash-tables as produced by the function create-serialize-hash.
circularities.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
backends.lisp (file)
circularities.lisp (file)
Return backup called NAME. If there is no such backend NIL is returned if ERRORP is false, otherwise an error is signalled.
backends.lisp (file)
utils.lisp (file)
utils.lisp (file)
circularities.lisp (file)
default-backend.lisp (file)
Read a signed or unsigned byte off STREAM.
utils.lisp (file)
default-backend.lisp (file)
plumbing.lisp (file)
restore (generic function)
plumbing.lisp (file)
Restore the object in PLACE using BACKEND
plumbing.lisp (file)
Write OBJ down STREAM as a 32 bit integer.
utils.lisp (file)
plumbing.lisp (file)
Store OBJ into STREAM. Not meant to be overridden, use backend-store-object instead
plumbing.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Wrapped by restore. Override this to do custom restoration
plumbing.lisp (file)
Restore an object from PLACE using BACKEND. Does the setup for various variables used by resolving-object.
circularities.lisp (file)
Restore the object found in stream PLACE using backend BACKEND. Checks the magic-number and invokes backend-restore-object
Restore the object found in file designator PLACE using backend BACKEND.
Restore the object found in file designator PLACE using backend BACKEND.
Find the next function to call with BACKEND and invoke it with PLACE.
plumbing.lisp (file)
Retrieve a object from PLACE, does housekeeping for circularity fixing.
circularities.lisp (file)
The default
Method wrapped by store, override this method for custom behaviour (see circularities.lisp).
plumbing.lisp (file)
Store OBJ into PLACE. Does the setup for counters and seen values.
circularities.lisp (file)
circularities.lisp (file)
The default. Checks the streams element-type, stores the backend code and calls store-object.
Store OBJ into file designator PLACE.
Store OBJ into file designator PLACE.
Wrapped by store-object, override this to do custom storing (see circularities.lisp for an example).
plumbing.lisp (file)
Store object if we have not seen this object before, otherwise retrieve the referrer object for it and store that using store-referrer.
circularities.lisp (file)
The default, just calls internal-store-object.
plumbing.lisp (file)
Check to see if STREAM actually contains a stored object for BACKEND.
plumbing.lisp (file)
Method which must be specialized for BACKEND to return
the next function to restore an object from PLACE.
If no reader is found return a second value which will be included
in the error.
plumbing.lisp (file)
default-backend.lisp (file)
The default, throw an error.
Return a list of slot details which can be used as an argument to ensure-class
utils.lisp (file)
circularities.lisp (file)
default-backend.lisp (file)
Is function FN registered to restore an integer or character in BACKEND.
Method which is specialized by defstore-? macros.
plumbing.lisp (file)
Definition for storing an object of type STRUCTURE-OBJECT with backend CL-STORE
custom.lisp (file)
Definition for storing an object of type GENERIC-FUNCTION with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type FUNCTION with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type PACKAGE with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type ARRAY with backend CL-STORE
default-backend.lisp (file)
default-backend.lisp (file)
Definition for storing an object of type BUILT-IN-CLASS with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type STANDARD-CLASS with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type CONDITION with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type STANDARD-OBJECT with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type HASH-TABLE with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type PATHNAME with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type CONS with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type SYMBOL with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type COMPLEX with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type CHARACTER with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type RATIO with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type FLOAT with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type INTEGER with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type (EQL NIL) with backend CL-STORE
default-backend.lisp (file)
Definition for storing an object of type (EQL T) with backend CL-STORE
default-backend.lisp (file)
If call falls back here then OBJ cannot be serialized with BACKEND.
automatically generated reader method
backends.lisp (file)
automatically generated writer method
backends.lisp (file)
circularities.lisp (file)
default-backend.lisp (file)
Restore and object FROM PLACE using BACKEND. Not meant to be overridden, use backend-restore instead
plumbing.lisp (file)
(setf restore) (function)
Entry point for restoring objects (setfable).
automatically generated reader method
default-backend.lisp (file)
automatically generated writer method
default-backend.lisp (file)
Return a list of slot-definitions to serialize. The default is to call serializable-slots-using-class with the object and the objects class
utils.lisp (file)
Return a list of slot-definitions to serialize. The default calls compute slots with class
utils.lisp (file)
Store OBJ into Stream PLACE using backend BACKEND.
plumbing.lisp (file)
Store OBJ into Stream PLACE using backend BACKEND.
Store magic-number of BACKEND, when present, into STREAM.
plumbing.lisp (file)
Store the number OBJ into PLACE as a referrer for BACKEND.
circularities.lisp (file)
default-backend.lisp (file)
automatically generated reader method
backends.lisp (file)
automatically generated writer method
backends.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
Root cl-store condition
plumbing.lisp (file)
error (condition)
:caused-by
(quote nil)
caused-by (generic function)
(setf caused-by) (generic function)
:format-string
(quote "unknown")
format-string (generic function)
(setf format-string) (generic function)
:format-args
(quote nil)
format-args (generic function)
(setf format-args) (generic function)
Error thrown when restoring an object fails.
plumbing.lisp (file)
cl-store-error (condition)
Error thrown when storing an object fails.
plumbing.lisp (file)
cl-store-error (condition)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
Core class which custom backends must extend
backends.lisp (file)
standard-object (class)
resolving-backend (class)
symbol
:name
:|unknown|
name (generic function)
(setf name) (generic function)
integer
:magic-number
magic-number (generic function)
(setf magic-number) (generic function)
list
:compatible-magic-numbers
compatible-magic-numbers (generic function)
(setf compatible-magic-numbers) (generic function)
list
:old-magic-numbers
old-magic-numbers (generic function)
(setf old-magic-numbers) (generic function)
(or symbol cons)
:stream-type
(cl-store::required-arg :stream-type)
stream-type (generic function)
(setf stream-type) (generic function)
Autogenerated cl-store class for backend cl-store.
default-backend.lisp (file)
resolving-backend (class)
(make-hash-table :size 100)
restorers (generic function)
(setf restorers) (generic function)
File containing implementation dependent code which may or may not be there.
cl-store.asd
cl-source-file (class)
A backend which does the setup for resolving circularities.
circularities.lisp (file)
backend (class)
cl-store (class)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal structures | ||
• Internal types |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
Next: Internal macros, Previous: Internal constants, Up: Internal definitions [Contents][Index]
default-backend.lisp (file)
Largest character that can be represented in 8 bits
default-backend.lisp (file)
default-backend.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
An assoc list mapping backend-names to the backend objects
backends.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
utils.lisp (file)
circularities.lisp (file)
utils.lisp (file)
utils.lisp (file)
utils.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
backends.lisp (file)
default-backend.lisp (file)
plumbing.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
default-backend.lisp (file)
Returns a alist of special float to float code mappings.
custom.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
circularities.lisp (file)
backends.lisp (file)
default-backend.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
Return the defrestore-? macro which will be used by a custom backend
backends.lisp (file)
circularities.lisp (file)
Return the defstore-? macro which will be used by a custom backend
backends.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
utils.lisp (file)
cl-store.asd
default-backend.lisp (file)
plumbing.lisp (file)
circularities.lisp (file)
utils.lisp (file)
Do we need to check if this object has been stored before?
circularities.lisp (file)
Tries to get a referred value to reduce unnecessary cirularity fixing.
circularities.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
Return the value REFERRER is meant to be by looking in HASH.
circularities.lisp (file)
circularities.lisp (file)
circularities.lisp (file)
backends.lisp (file)
default-backend.lisp (file)
backends.lisp (file)
plumbing.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
Similar to ‘list-length’, but avoid errors on improper lists. Return two values: the length of the list and the last cdr. Modified to work on non proper lists.
utils.lisp (file)
Has this object already been stored?
circularities.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
plumbing.lisp (file)
default-backend.lisp (file)
Concatenate all symbol names into one big symbol
utils.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
An implementation specific test for a unicode string.
default-backend.lisp (file)
circularities.lisp (file)
Register OBJ as having been stored.
circularities.lisp (file)
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
backends.lisp (file)
automatically generated writer method
backends.lisp (file)
plumbing.lisp (file)
plumbing.lisp (file)
plumbing.lisp (file)
custom.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
default-backend.lisp (file)
automatically generated reader method
backends.lisp (file)
automatically generated writer method
backends.lisp (file)
automatically generated reader method
backends.lisp (file)
automatically generated writer method
backends.lisp (file)
Next: Internal types, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
circularities.lisp (file)
structure-object (structure)
delay-value (function)
(setf delay-value) (function)
delay-completed (function)
(setf delay-completed) (function)
circularities.lisp (file)
structure-object (structure)
referrer-val (function)
(setf referrer-val) (function)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
The maximum size of a vector
utils.lisp (file)
The maximum total size of an array
utils.lisp (file)
backends.lisp (file)
Type grouping integers and characters, which we don’t bother to check if they have been stored before
circularities.lisp (file)
utils.lisp (file)
utils.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
A B C D E F G H I K L M N O P R S U W |
---|
Jump to: | (
A B C D E F G H I K L M N O P R S U W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
+
C F M N O R S V |
---|
Jump to: | *
+
C F M N O R S V |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | A B C D N P R S T U |
---|
Jump to: | A B C D N P R S T U |
---|