This is the simpbin Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jul 13 21:58:20 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
simpbinA common lisp library to store data in a binary format
Francis St-Amour
GNU GPLv3
0.0.1
alexandria (system).
flexi-streams (system).
fast-io (system).
nibbles (system).
simpbin.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
simpbin/simpbin.lispsimpbin (system).
read-binary-string (function).
read-binary-string* (function).
read-bit-vector (function).
read-header (function).
read-integer (function).
read-octets (function).
read-octets* (function).
read-varint (function).
with-input-from-binary-file (macro).
with-output-to-binary-file (macro).
write-binary-string (function).
write-binary-string* (function).
write-bit-vector (function).
write-header (function).
write-integer (function).
write-octets (function).
write-octets* (function).
write-varint (function).
+integer-length+ (constant).
varint-length (function).
Packages are listed by definition order.
simpbincommon-lisp.
read-binary-string (function).
read-binary-string* (function).
read-bit-vector (function).
read-header (function).
read-integer (function).
read-octets (function).
read-octets* (function).
read-varint (function).
with-input-from-binary-file (macro).
with-output-to-binary-file (macro).
write-binary-string (function).
write-binary-string* (function).
write-bit-vector (function).
write-header (function).
write-integer (function).
write-octets (function).
write-octets* (function).
write-varint (function).
+integer-length+ (constant).
varint-length (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Helper macro to open a file with the right element-type for binary input.
Helper macro to open a file with the right element-type for binary output.
Read a STRING from STREAM. Use a 32-bits unsigned integer to store the size of the string.
Read a string from STREAM. Use a varint to store the size of the string.
Read a bit-vector from STREAM.
Read a header from the stream, verifies the signature and returns the variant number.
Read a 32 bit, little-endian unsigned INTEGER from STREAM.
Read an OCTET-VECTOR from STREAM.
Read the length of the vector first, then the content.
Use a 32-bits unsigned integer to store the size of the vector.
Read an OCTET-VECTOR to STREAM.
Read the length of the vector first, then the content.
Use a varint to store the size of the vector.
Read a varint-encoded integer from STREAM.
Write a STRING to STREAM. Use a 32-bits unsigned integer to store the size of the string.
Write a STRING to STREAM. Use a varint to store the size of the string.
Write a BIT-VECTOR to STREAM.
The vector is written in 32-bit chunks, padding is added if necessary.
Use varint to store the size, in number of bits, of the bit-vector.
Write a header to the stream
Write a 32 bit, little-endian unsigned INTEGER to STREAM.
Write an OCTET-VECTOR to STREAM.
First the size is written, then the content of the vector.
Use a 32-bits unsigned integer to store the size of the vector.
Write an OCTET-VECTOR to STREAM.
First the size is written, then the content of the vector.
Use a varint to store the size of the vector.
Write the unsigned INTEGER to STREAM as a varint.
| Jump to: | F M R V W |
|---|
| Jump to: | F M R V W |
|---|
| Jump to: | +
C |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| + | |||
+integer-length+: | Private constants | ||
| | |||
| C | |||
Constant, +integer-length+: | Private constants | ||
| | |||
| Jump to: | +
C |
|---|
| Jump to: | F P S |
|---|
| Jump to: | F P S |
|---|