This is the protobuf Reference Manual, version 0.9.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:25:10 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
protobufProtocol buffer code
Robert Brown <robert.brown@gmail.com>
See file COPYING and the copyright messages in individual files.
A Common Lisp implementation of Google’s protocol buffer serialization libraries.
0.9.3
com.google.base (system).
com.google.base (system).
varint (system).
copying (file).
readme.md (file).
todo (file).
package.lisp (file).
protocol-buffer.lisp (file).
wire-format.lisp (file).
varintVariable-size encoding and decoding of integers.
Robert Brown <robert.brown@gmail.com>
New BSD license. See the copyright messages in individual files.
0.1
com.google.base (system).
com.google.base (system).
nibbles (system).
package.lisp (file).
varint.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
protobuf/protobuf.asdvarint/varint.asdprotobuf/package.lispprotobuf/protocol-buffer.lispprotobuf/wire-format.lispvarint/package.lispvarint/varint.lispprotobuf/protobuf.asdprotobuf (system).
*protoc-relative-path* (special variable).
component-depends-on (method).
component-depends-on (method).
input-files (method).
input-files (method).
output-files (method).
perform (method).
perform (method).
proto-pathname (reader method).
protobuf-source-file (class).
search-path (reader method).
component-self-dependencies (method).
proto-input (function).
proto-to-lisp (class).
protobuf-compile-failed (condition).
resolve-relative-pathname (function).
resolve-search-path (function).
protobuf/protocol-buffer.lisppackage.lisp (file).
protobuf (system).
clear (generic function).
is-initialized (generic function).
merge-from-array (generic function).
merge-from-message (generic function).
octet-size (generic function).
print-object (method).
protocol-buffer (class).
serialize (generic function).
string-field (function).
string-value (function).
utf8-string-value (function).
%octets% (reader method).
(setf %octets%) (writer method).
%sf% (class).
%utf8-string-length% (function).
+double-float-nan+ (symbol macro).
+double-float-negative-infinity+ (symbol macro).
+double-float-positive-infinity+ (symbol macro).
+single-float-nan+ (symbol macro).
+single-float-negative-infinity+ (symbol macro).
+single-float-positive-infinity+ (symbol macro).
protobuf/wire-format.lisppackage.lisp (file).
protobuf (system).
+end-group+ (constant).
+fixed32+ (constant).
+fixed64+ (constant).
+length-delimited+ (constant).
+start-group+ (constant).
+varint+ (constant).
alignment (condition).
buffer-overflow (condition).
data-exhausted (condition).
encoding-error (condition).
field-number (type).
parse-tag (function).
parsing-error (condition).
protocol-error (condition).
read-boolean-carefully (function).
read-double-float-carefully (function).
read-int32-carefully (function).
read-int64-carefully (function).
read-octets-carefully (function).
read-single-float-carefully (function).
read-uint32-carefully (function).
read-uint64-carefully (function).
skip-field (function).
value-out-of-range (condition).
wire-type (type).
write-boolean-carefully (function).
write-double-float-carefully (function).
write-int32-carefully (function).
write-int64-carefully (function).
write-octets-carefully (function).
write-single-float-carefully (function).
write-uint32-carefully (function).
write-uint64-carefully (function).
zig-zag-decode32 (function).
zig-zag-decode64 (function).
zig-zag-encode32 (function).
zig-zag-encode64 (function).
varint/varint.lisppackage.lisp (file).
varint (system).
+max-octets-32+ (constant).
+max-octets-64+ (constant).
alignment (condition).
buffer-overflow (condition).
data-exhausted (condition).
encode-uint32 (function).
encode-uint32-carefully (function).
encode-uint64 (function).
encode-uint64-carefully (function).
encoding-error (condition).
length-int32 (function).
length-uint32 (function).
length-uint64 (function).
parse-int32-carefully (function).
parse-int64-carefully (function).
parse-uint31-carefully (function).
parse-uint32 (function).
parse-uint32-carefully (function).
parse-uint64 (function).
parse-uint64-carefully (function).
parse32-backward (function).
parse32-backward-slow (function).
parse64-backward (function).
parse64-backward-slow (function).
parsing-error (condition).
skip32-backward (function).
skip32-backward-slow (function).
skip32-carefully (function).
skip64-backward (function).
skip64-backward-slow (function).
skip64-carefully (function).
value-out-of-range (condition).
varint-error (condition).
Packages are listed by definition order.
protocol-bufferMachine generated protocol buffers.
pb
clear (generic function).
is-initialized (generic function).
merge-from-array (generic function).
merge-from-message (generic function).
octet-size (generic function).
protocol-buffer (class).
serialize (generic function).
string-field (function).
string-value (function).
utf8-string-value (function).
%octets% (generic reader).
(setf %octets%) (generic writer).
%sf% (class).
%utf8-string-length% (function).
+double-float-nan+ (symbol macro).
+double-float-negative-infinity+ (symbol macro).
+double-float-positive-infinity+ (symbol macro).
+single-float-nan+ (symbol macro).
+single-float-negative-infinity+ (symbol macro).
+single-float-positive-infinity+ (symbol macro).
wire-formatWire format for protocol buffers.
com.google.base.
common-lisp.
+end-group+ (constant).
+fixed32+ (constant).
+fixed64+ (constant).
+length-delimited+ (constant).
+start-group+ (constant).
+varint+ (constant).
alignment (condition).
buffer-overflow (condition).
data-exhausted (condition).
encoding-error (condition).
field-number (type).
parse-tag (function).
parsing-error (condition).
protocol-error (condition).
read-boolean-carefully (function).
read-double-float-carefully (function).
read-int32-carefully (function).
read-int64-carefully (function).
read-octets-carefully (function).
read-single-float-carefully (function).
read-uint32-carefully (function).
read-uint64-carefully (function).
skip-field (function).
value-out-of-range (condition).
wire-type (type).
write-boolean-carefully (function).
write-double-float-carefully (function).
write-int32-carefully (function).
write-int64-carefully (function).
write-octets-carefully (function).
write-single-float-carefully (function).
write-uint32-carefully (function).
write-uint64-carefully (function).
zig-zag-decode32 (function).
zig-zag-decode64 (function).
zig-zag-encode32 (function).
zig-zag-encode64 (function).
protobuf-configConfiguration information for PROTOBUF.
common-lisp.
*protoc-relative-path* (special variable).
protobuf-systemSystem definitions for protocol buffer code.
asdf/interface.
common-lisp.
protobuf-config.
proto-input (function).
proto-to-lisp (class).
protobuf-compile-failed (condition).
resolve-relative-pathname (function).
resolve-search-path (function).
varintVariable-size encoding and decoding of integers
com.google.base.
common-lisp.
+max-octets-32+ (constant).
+max-octets-64+ (constant).
alignment (condition).
buffer-overflow (condition).
data-exhausted (condition).
encode-uint32 (function).
encode-uint32-carefully (function).
encode-uint64 (function).
encode-uint64-carefully (function).
encoding-error (condition).
length-int32 (function).
length-uint32 (function).
length-uint64 (function).
parse-int32-carefully (function).
parse-int64-carefully (function).
parse-uint31-carefully (function).
parse-uint32 (function).
parse-uint32-carefully (function).
parse-uint64 (function).
parse-uint64-carefully (function).
parse32-backward (function).
parse32-backward-slow (function).
parse64-backward (function).
parse64-backward-slow (function).
parsing-error (condition).
skip32-backward (function).
skip32-backward-slow (function).
skip32-carefully (function).
skip64-backward (function).
skip64-backward-slow (function).
skip64-carefully (function).
value-out-of-range (condition).
varint-error (condition).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Wire type marking the end of a group. Deprecated.
Wire type used for 4-byte integers or single precision floats.
Wire type used for 8-byte integers or double precision floats.
Wire type used for length-delimited values, such as strings, bytes, embedded messages, and packed repeated fields.
Maximum number of octets needed to encode a 32-bit integer.
Maximum number of octets needed to encode a 64-bit integer.
Wire type marking the start of a group. Deprecated.
Wire type used for variable length integers, booleans, and enums.
Supply relative proto file paths to protoc, the protobuf compiler?
Encode V, an unsigned 32-bit integer, into BUFFER at INDEX.
Encode V, an unsigned 32-bit integer, into BUFFER at INDEX, taking care to never write past position LIMIT. If writing past LIMIT is required to encode V, then raise ENCODE-OVERFLOW.
Encode V, an unsigned 64-bit integer, into BUFFER at INDEX.
Encode V, an unsigned 64-bit integer, into BUFFER at INDEX, taking care to never write past position LIMIT. If writing past LIMIT is required to encode V, then raise BUFFER-OVERFLOW.
Parse the varint protobuf tag at position INDEX of BUFFER, being careful to
only read positions below LIMIT. When successful, return three integers: the
field number, the encoding wire type, and the position in BUFFER where the
field value is stored.
PARSE-TAG signals DATA-EXHAUSTED when parsing the tag requires reading beyond LIMIT and signals VALUE-OUT-OF-RANGE when the field number is zero or the encoded tag is too large.
Read a DOUBLE-FLOAT from BUFFER starting at INDEX. The float is stored in BUFFER as an 8-octet little-endian IEEE double precision value. Both the float and the index of the first octet following it are returned. If reading the float would require octets beyond LIMIT, then signal DATA-EXHAUSTED.
Read a SINGLE-FLOAT from BUFFER starting at INDEX. The float is stored in BUFFER as a 4-octet little-endian IEEE single precision value. Both the float and the index of the first octet following it are returned. If reading the float would require octets beyond LIMIT, then signal DATA-EXHAUSTED.
Returns a new %SF% instance initialized to hold VALUE, which much be either a Lisp string or a vector of UTF-8 encoded octets.
Returns STRING-FIELD’s value as a Lisp string.
Returns STRING-FIELD’s value as a UTF-8 encoded vector of octets.
Write the little-endian IEEE binary representation of single precision FLOAT to BUFFER starting at INDEX. Return the index value of the first octet following FLOAT. If encoding FLOAT requires space in BUFFER past LIMIT, then signal BUFFER-OVERFLOW.
Write the little-endian IEEE binary representation of double precision FLOAT to BUFFER starting at INDEX. Return the index value of the first octet following FLOAT. If encoding FLOAT requires space in BUFFER past LIMIT, then signal BUFFER-OVERFLOW.
Sets the slots of PROTOCOL-BUFFER to their default values.
Are all the slots of PROTOCOL-BUFFER initialized?
Merges the contents of the encoded protocol buffer stored in BUFFER into PROTOCOL-BUFFER. When reading from BUFFER, begins at position START and does not read from position LIMIT or higher. If deserialization demands reading beyond LIMIT, then signals PROTOCOL-BUFFER-READ-ERROR.
Merges the contents of SOURCE-PROTOCOL-BUFFER into PROTOCOL-BUFFER.
Returns the number of octets required to represent PROTOCOL-BUFFER when it is encoded.
Serializes PROTOCOL-BUFFER into BUFFER. Starts writing at position INDEX of
BUFFER, but does not write into position LIMIT or higher. If serialization
demands writing past LIMIT, then signals PROTOCOL-BUFFER-WRITE-ERROR.
OCTET-SIZE must be called immediately before SERIALIZE because PROTOCOL-BUFFER instances cache size information.
load-op) (component protobuf-source-file)) ¶Loading a protocol buffer file depends on generating Lisp source code for the protobuf, but also on loading package definitions and in-line function definitions that the machine-generated protobuf Lisp code uses.
asdf/action.
compile-op) (component protobuf-source-file)) ¶Compiling a protocol buffer file depends on generating Lisp source code for the protobuf, but also on loading package definitions and in-line function definitions that the machine-generated protobuf Lisp code uses.
asdf/action.
proto-to-lisp) (component protobuf-source-file)) ¶asdf/action.
compile-op) (c protobuf-source-file)) ¶asdf/action.
proto-to-lisp) (component protobuf-source-file)) ¶Arranges for the Lisp output file of PROTO-TO-LISP operations to be stored where fasl files are located.
asdf/action.
proto-to-lisp) (component protobuf-source-file)) ¶asdf/action.
proto-to-lisp) (component protobuf-source-file)) ¶asdf/action.
protobuf-source-file)) ¶Relative pathname that specifies the location of a .proto file.
asdf/interface.
protobuf-source-file)) ¶List containing directories where the protocol buffer compiler should search for imported protobuf files. Non-absolute pathnames are treated as relative to the directory containing the DEFSYSTEM form in which they appear.
asdf/interface.
Bad data encountered while skipping a field.
Data buffer does not contain the type of value we have been asked to skip over or parse backwards.
Buffer space exhausted while encoding a value.
Buffer space exhausted while encoding a value.
Decoding a value requires more data than is available.
Decoding a value requires more data than is available.
Superclass of conditions signalled while encoding values.
Superclass of all VARINT encoding conditions.
Superclass of conditions signalled while decoding values.
Superclass of all VARINT decoding conditions.
Superclass of all PROTOCOL-BUFFER conditions.
error.
Value decoded is outside the range of the return type.
Value decoded is outside the range of the return type.
Superclass of all VARINT conditions.
error.
A protocol buffer definition file.
asdf/interface.
cl-source-file.
Relative pathname that specifies the location of a .proto file.
:proto-pathname
This slot is read-only.
List containing directories where the protocol buffer compiler should search for imported protobuf files. Non-absolute pathnames are treated as relative to the directory containing the DEFSYSTEM form in which they appear.
:proto-search-path
This slot is read-only.
Superclass of all protocol buffer classes.
Returns the length in octets of STRING-FIELD’s value.
Returns the pathname of the protocol buffer definition file that must be translated into Lisp source code for this PROTO-FILE component.
When PATH doesn’t have an absolute directory component, treat it as relative to PARENT-PATH.
load-op) (c protobuf-source-file)) ¶Removes PROTO-TO-LISP operations from self dependencies. Otherwise, the Lisp output files of PROTO-TO-LISP are considered to be input files for LOAD-OP, which means ASDF loads both the .lisp file and the .fasl file.
asdf/interface.
Condition signalled when translating a .proto file into Lisp code fails.
compile-failed-error.
A protocol buffer string field.
Octet vector that holds the string field’s value.
com.google.base:octet-vector
(make-array 0 :element-type (quote (unsigned-byte 8)))
:octets
An ASDF operation that compiles a .proto file containing protocol buffer definitions into a Lisp source file.
downward-operation.
selfward-operation.
asdf/action.
:class
(quote asdf/lisp-action:prepare-op)
| Jump to: | %
(
C E F G I L M O P R S U W Z |
|---|
| Jump to: | %
(
C E F G I L M O P R S U W Z |
|---|
| Jump to: | %
*
+
C R S |
|---|
| Jump to: | %
*
+
C R S |
|---|
| Jump to: | %
A B C D E F P R S T V W |
|---|
| Jump to: | %
A B C D E F P R S T V W |
|---|