This is the cbor Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 03:27:48 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cborCBOR encoder/decoder
Mihai Bazon <mihai.bazon@gmail.com>
MIT
0.0.1
trivial-utf-8 (system).
ieee-floats (system).
local-time (system).
closer-mop (system).
package.lisp (file).
cbor.lisp (file).
errors.lisp (file).
stringref.lisp (file).
circular.lisp (file).
memstream.lisp (file).
encode.lisp (file).
decode.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cbor/cbor.asdcbor/package.lispcbor/cbor.lispcbor/errors.lispcbor/stringref.lispcbor/circular.lispcbor/memstream.lispcbor/encode.lispcbor/decode.lispcbor/cbor.lisppackage.lisp (file).
cbor (system).
*array-format* (special variable).
*custom-tag-reader* (special variable).
*dictionary-format* (special variable).
*jsown-semantics* (special variable).
*strict* (special variable).
*string-to-symbol* (special variable).
*symbol-to-string* (special variable).
*symbols-package* (special variable).
*use-sharedrefs* (special variable).
*use-stringrefs* (special variable).
*max-uint64* (special variable).
*min-uint64* (special variable).
*optimize* (special variable).
+tag-bigfloat+ (constant).
+tag-cbor+ (constant).
+tag-character+ (constant).
+tag-complex+ (constant).
+tag-decimal-fraction+ (constant).
+tag-encoded-cbor+ (constant).
+tag-float-datetime+ (constant).
+tag-list+ (constant).
+tag-negative-bignum+ (constant).
+tag-object+ (constant).
+tag-positive-bignum+ (constant).
+tag-ratio+ (constant).
+tag-shareable+ (constant).
+tag-sharedref+ (constant).
+tag-string-datetime+ (constant).
+tag-stringref+ (constant).
+tag-stringref-namespace+ (constant).
+tag-symbol+ (constant).
decode-float16 (function).
encode-float16 (function).
raw-data (type).
cbor/errors.lispcbor.lisp (file).
cbor (system).
cbor-decode-error (condition).
cbor-encode-error (condition).
cbor-error (condition).
error-position (reader method).
error-stream (reader method).
error-text (reader method).
decode-error (macro).
encode-error (macro).
cbor/stringref.lisperrors.lisp (file).
cbor (system).
*stringref-cache* (special variable).
stringref-assign (function).
stringref-get (function).
stringref-should-cache (function).
with-stringrefs (macro).
cbor/circular.lispstringref.lisp (file).
cbor (system).
*in-shareable* (special variable).
*sharedref-cache* (special variable).
*sharedref-index* (special variable).
decode-get-shareable (function).
decode-set-shareable (function).
dig-references (function).
encode-maybe-shared (macro).
shared-value (function).
with-decode-shareable (macro).
with-sharedrefs-decode (macro).
with-sharedrefs-encode (macro).
cbor/memstream.lispcircular.lisp (file).
cbor (system).
make-memstream (function).
memstream (structure).
ms-peek-byte (function).
ms-read-byte (function).
ms-read-sequence (function).
ms-whole-data (function).
ms-write-byte (function).
ms-write-sequence (function).
with-ms-position (macro).
%make-memstream (function).
*buffer-size* (special variable).
copy-memstream (function).
memstream-p (function).
ms-data (reader).
(setf ms-data) (writer).
ms-extend-stream (function).
ms-position (reader).
(setf ms-position) (writer).
ms-size (reader).
(setf ms-size) (writer).
with-stream-slots (macro).
cbor/encode.lispmemstream.lisp (file).
cbor (system).
encode (function).
encode-object (generic function).
%encode (function).
encode-alist (function).
encode-array (function).
encode-bignum (function).
encode-binary (function).
encode-character (function).
encode-complex (function).
encode-false (function).
encode-float (function).
encode-hash (function).
encode-list (function).
encode-list* (function).
encode-negative-integer (function).
encode-null (function).
encode-positive-integer (function).
encode-ratio (function).
encode-string (function).
encode-symbol (function).
encode-true (function).
encode-undefined (function).
unroll-write-byte (macro).
with-dictionary (macro).
write-tag (function).
cbor/decode.lispencode.lisp (file).
cbor (system).
decode (function).
%decode (function).
%decode-float (function).
%decode-no-shareable (function).
%make-symbol (function).
build-list (macro).
read-array (function).
read-bigfloat (function).
read-bignum (function).
read-binary (function).
read-character (function).
read-complex (function).
read-datetime (function).
read-decimal-fraction (function).
read-encoded-cbor (function).
read-entries (function).
read-list* (function).
read-map (function).
read-object (function).
read-ratio (function).
read-string (function).
read-string-datetime (function).
read-stringref (function).
read-symbol (function).
read-tagged (function).
unroll-read-byte (macro).
with-tag (macro).
Packages are listed by definition order.
cborcommon-lisp.
*array-format* (special variable).
*custom-tag-reader* (special variable).
*dictionary-format* (special variable).
*jsown-semantics* (special variable).
*strict* (special variable).
*string-to-symbol* (special variable).
*symbol-to-string* (special variable).
*symbols-package* (special variable).
*use-sharedrefs* (special variable).
*use-stringrefs* (special variable).
cbor-decode-error (condition).
cbor-encode-error (condition).
cbor-error (condition).
decode (function).
encode (function).
encode-object (generic function).
error-position (generic reader).
error-stream (generic reader).
error-text (generic reader).
make-memstream (function).
memstream (structure).
ms-peek-byte (function).
ms-read-byte (function).
ms-read-sequence (function).
ms-whole-data (function).
ms-write-byte (function).
ms-write-sequence (function).
with-ms-position (macro).
%decode (function).
%decode-float (function).
%decode-no-shareable (function).
%encode (function).
%make-memstream (function).
%make-symbol (function).
*buffer-size* (special variable).
*in-shareable* (special variable).
*max-uint64* (special variable).
*min-uint64* (special variable).
*optimize* (special variable).
*sharedref-cache* (special variable).
*sharedref-index* (special variable).
*stringref-cache* (special variable).
+tag-bigfloat+ (constant).
+tag-cbor+ (constant).
+tag-character+ (constant).
+tag-complex+ (constant).
+tag-decimal-fraction+ (constant).
+tag-encoded-cbor+ (constant).
+tag-float-datetime+ (constant).
+tag-list+ (constant).
+tag-negative-bignum+ (constant).
+tag-object+ (constant).
+tag-positive-bignum+ (constant).
+tag-ratio+ (constant).
+tag-shareable+ (constant).
+tag-sharedref+ (constant).
+tag-string-datetime+ (constant).
+tag-stringref+ (constant).
+tag-stringref-namespace+ (constant).
+tag-symbol+ (constant).
build-list (macro).
copy-memstream (function).
decode-error (macro).
decode-float16 (function).
decode-get-shareable (function).
decode-set-shareable (function).
dig-references (function).
encode-alist (function).
encode-array (function).
encode-bignum (function).
encode-binary (function).
encode-character (function).
encode-complex (function).
encode-error (macro).
encode-false (function).
encode-float (function).
encode-float16 (function).
encode-hash (function).
encode-list (function).
encode-list* (function).
encode-maybe-shared (macro).
encode-negative-integer (function).
encode-null (function).
encode-positive-integer (function).
encode-ratio (function).
encode-string (function).
encode-symbol (function).
encode-true (function).
encode-undefined (function).
memstream-p (function).
ms-data (reader).
(setf ms-data) (writer).
ms-extend-stream (function).
ms-position (reader).
(setf ms-position) (writer).
ms-size (reader).
(setf ms-size) (writer).
raw-data (type).
read-array (function).
read-bigfloat (function).
read-bignum (function).
read-binary (function).
read-character (function).
read-complex (function).
read-datetime (function).
read-decimal-fraction (function).
read-encoded-cbor (function).
read-entries (function).
read-list* (function).
read-map (function).
read-object (function).
read-ratio (function).
read-string (function).
read-string-datetime (function).
read-stringref (function).
read-symbol (function).
read-tagged (function).
shared-value (function).
stringref-assign (function).
stringref-get (function).
stringref-should-cache (function).
unroll-read-byte (macro).
unroll-write-byte (macro).
with-decode-shareable (macro).
with-dictionary (macro).
with-sharedrefs-decode (macro).
with-sharedrefs-encode (macro).
with-stream-slots (macro).
with-stringrefs (macro).
with-tag (macro).
write-tag (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Bind this to :list if you want arrays to decode as lists. Note that the empty array will be NIL in this case.
Custom tag reader function, for tags not supported by ‘read-tagged’. Receives tag number and the value.
How to decode dictionaries. Supports :HASH, :ALIST or :PLIST. When :HASH (the default), dictionaries are decoded into hash tables using #’EQ as test when *string-to-symbol* is bound, or #’EQUAL otherwise.
Bind this to T if you want encode/decode to use JSOWN’s conventions.
Strict mode: use the custom tags above for precise serialization of various Common Lisp types that are not defined in the core CBOR spec. A decoder must support these types for proper de-serialization.
A function that converts strings to symbols. Applied for dictionary name and keys. If bound to NIL while decoding, strings will be left alone.
A function that converts symbols to strings. If bound to NIL while encoding, ‘symbol-name’ will be used instead.
Package to intern symbols into. Used by the default implementation of ‘*string-to-symbol*’.
Wether to use the shared value extension for
encoding (http://cbor.schmorp.de/value-sharing). Decoding always
supports it if it encounters the tags.
Wether to use the stringrefs extension for encoding (http://cbor.schmorp.de/stringref). Decoding always supports it, if it encounters the tag.
cbor.
cbor-error)) ¶cbor.
cbor-error)) ¶cbor.
cbor-error)) ¶text.
cbor.
error.
:text
This slot is read-only.
common-lisp.
:stream
This slot is read-only.
common-lisp.
:position
This slot is read-only.
cbor.
structure-object.
cbor::raw-data
(make-array cbor::*buffer-size* :element-type (quote (unsigned-byte 8)))
common-lisp.
(integer 0 17592186044416)
0
(integer 0 17592186044416)
0
cbor.
cbor.
cbor.
cbor.
cbor.
cbor.
cbor.
cbor.
cbor.
cbor.
Builds a set (as a hash table) of objects that are seen more than once. Will return NIL if no duplicates are encountered.
cbor.
cbor.
cbor.
| Jump to: | %
(
B C D E F G M R S U W |
|---|
| Jump to: | %
(
B C D E F G M R S U W |
|---|
| Jump to: | *
+
C D P S T |
|---|
| Jump to: | *
+
C D P S T |
|---|
| Jump to: | C D E F M P R S T |
|---|
| Jump to: | C D E F M P R S T |
|---|