This is the binary-io Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 03:26:28 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
binary-ioLibrary for reading and writing binary data.
Peter Seibel <peter@gigamonkeys.com>
alexandria (system).
ieee-floats (system).
sb-posix (system).
packages.lisp (file).
binary-data.lisp (file).
common-datatypes.lisp (file).
mmap.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
binary-io/binary-io.asdbinary-io/packages.lispbinary-io/binary-data.lispbinary-io/common-datatypes.lispbinary-io/mmap.lispbinary-io/binary-data.lisppackages.lisp (file).
binary-io (system).
*in-progress-objects* (special variable).
+null+ (constant).
current-binary-object (function).
define-binary-class (macro).
define-binary-type (macro).
define-bitfield (macro).
define-enumeration (macro).
define-tagged-binary-class (macro).
immediate-parent (function).
parent-of-type (function).
read-value (generic function).
type-size (generic function).
write-value (generic function).
all-slots (function).
as-keyword (function).
define-generic-binary-class (macro).
direct-slots (function).
inherited-slots (function).
mklist (function).
new-class-all-slots (function).
normalize-mapping (function).
normalize-slot-spec (function).
object-size (generic function).
read-object (generic function).
rw-alistp (function).
slot->binding (function).
slot->defclass-slot (function).
slot->keyword-arg (function).
slot->object-size (function).
slot->read-value (function).
slot->write-value (function).
type-reader-body (function).
type-size-body (function).
type-writer-body (function).
write-object (generic function).
binary-io/common-datatypes.lispbinary-data.lisp (file).
binary-io (system).
*endianness* (special variable).
marshaller (function).
pack (function).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
read-value (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
type-size (method).
ucs-2-char-type (function).
unmarshaller (function).
unpack (function).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
write-value (method).
build-signed (macro).
byte-indexes (function).
marshall-s16 (function).
marshall-s32 (function).
marshall-s64 (function).
marshall-s8 (function).
swap-bytes (function).
unmarshall-s16 (function).
unmarshall-s32 (function).
unmarshall-s64 (function).
unmarshall-s8 (function).
binary-io/mmap.lispcommon-datatypes.lisp (file).
binary-io (system).
close (method).
mmap-stream (class).
open-mmap (function).
read-value-at (generic function).
write-value-at (generic function).
make-mmap-stream (function).
make-read-write-value-at (macro).
mmap-stream-address (reader method).
mmap-stream-fd (reader method).
Packages are listed by definition order.
binary-ioalexandria.
common-lisp.
*in-progress-objects* (special variable).
+null+ (constant).
current-binary-object (function).
define-binary-class (macro).
define-binary-type (macro).
define-bitfield (macro).
define-enumeration (macro).
define-tagged-binary-class (macro).
immediate-parent (function).
mmap-stream (class).
open-mmap (function).
parent-of-type (function).
read-value (generic function).
read-value-at (generic function).
type-size (generic function).
write-value (generic function).
write-value-at (generic function).
all-slots (function).
as-keyword (function).
define-generic-binary-class (macro).
direct-slots (function).
inherited-slots (function).
make-mmap-stream (function).
make-read-write-value-at (macro).
mklist (function).
mmap-stream-address (generic reader).
mmap-stream-fd (generic reader).
new-class-all-slots (function).
normalize-mapping (function).
normalize-slot-spec (function).
object-size (generic function).
read-object (generic function).
rw-alistp (function).
slot->binding (function).
slot->defclass-slot (function).
slot->keyword-arg (function).
slot->object-size (function).
slot->read-value (function).
slot->write-value (function).
type-reader-body (function).
type-size-body (function).
type-writer-body (function).
write-object (generic function).
binary-io.common-datatypesbinary-io.
common-lisp.
*endianness* (special variable).
marshaller (function).
pack (function).
ucs-2-char-type (function).
unmarshaller (function).
unpack (function).
build-signed (macro).
byte-indexes (function).
marshall-s16 (function).
marshall-s32 (function).
marshall-s64 (function).
marshall-s8 (function).
swap-bytes (function).
unmarshall-s16 (function).
unmarshall-s32 (function).
unmarshall-s64 (function).
unmarshall-s8 (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Sets unsigned intergers read/write endianness. Should be one of :little or :big.
Return the marshalling function for TYPE. Can return NIL if nothing has to be done (this should be checked by the caller).
Make a vector of N-byte integers out of a BYTES vector. Defaults to octet as byte.
Return the unmarshalling function for TYPE. Can return NIL if nothing has to be done (this should be checked by the caller).
Opposite of PACK.
Read a value of the given type from the stream.
(eql binary-io.common-datatypes:8bit-string)) stream1 &key length terminator) ¶(eql binary-io.common-datatypes:ucs-2-terminated-string)) stream1 &key terminator) ¶(eql binary-io.common-datatypes:ucs-2-string)) stream1 &key length) ¶(eql binary-io.common-datatypes:ucs-2-char-little-endian)) stream1 &key) ¶(eql binary-io.common-datatypes:ucs-2-char-big-endian)) stream1 &key) ¶(eql binary-io.common-datatypes:ucs-2-char)) stream1 &key swap) ¶(eql binary-io.common-datatypes:iso-8859-1-terminated-string)) stream1 &key terminator) ¶(eql binary-io.common-datatypes:iso-8859-1-string)) stream1 &key length) ¶(eql binary-io.common-datatypes:iso-8859-1-char)) stream1 &key) ¶(eql binary-io.common-datatypes:generic-terminated-string)) stream1 &key terminator character-type) ¶(eql binary-io.common-datatypes:generic-string)) stream1 &key length character-type) ¶(eql :vector)) stream1 &key size type) ¶(eql :float64)) stream1 &key) ¶(eql :float32)) stream1 &key) ¶(eql :s64)) stream19 &key) ¶(eql :s32)) stream19 &key) ¶(eql :s16)) stream19 &key) ¶(eql :s8)) stream19 &key) ¶(eql :u64)) stream1 &key) ¶(eql :u32)) stream1 &key) ¶(eql :u16)) stream1 &key) ¶(eql :u8)) stream1 &key) ¶(eql binary-io.common-datatypes::unsigned-integer)) stream1 &key bits) ¶symbol) stream &key) ¶Read a value of the given TYPE from the STREAM at OFFSET.
(eql :vector)) (stream mmap-stream) offset &key size type) ¶(eql :float64)) (stream1 mmap-stream) offset3 &key) ¶(eql :float32)) (stream1 mmap-stream) offset3 &key) ¶(eql :s64)) (stream1 mmap-stream) offset3 &key) ¶(eql :s32)) (stream1 mmap-stream) offset3 &key) ¶(eql :s16)) (stream1 mmap-stream) offset3 &key) ¶(eql :s8)) (stream1 mmap-stream) offset3 &key) ¶(eql :u64)) (stream1 mmap-stream) offset3 &key) ¶(eql :u32)) (stream1 mmap-stream) offset3 &key) ¶(eql :u16)) (stream1 mmap-stream) offset3 &key) ¶(eql :u8)) (stream1 mmap-stream) offset3 &key) ¶Returns the octet size of a type.
(eql binary-io.common-datatypes:8bit-string)) &key length terminator) ¶(eql binary-io.common-datatypes:ucs-2-terminated-string)) &key terminator) ¶(eql binary-io.common-datatypes:ucs-2-string)) &key length) ¶(eql binary-io.common-datatypes:ucs-2-char-little-endian)) &key) ¶(eql binary-io.common-datatypes:ucs-2-char-big-endian)) &key) ¶(eql binary-io.common-datatypes:ucs-2-char)) &key swap) ¶(eql binary-io.common-datatypes:iso-8859-1-terminated-string)) &key terminator) ¶(eql binary-io.common-datatypes:iso-8859-1-string)) &key length) ¶(eql binary-io.common-datatypes:iso-8859-1-char)) &key) ¶(eql binary-io.common-datatypes:generic-terminated-string)) &key terminator character-type) ¶(eql binary-io.common-datatypes:generic-string)) &key length character-type) ¶(eql :vector)) &key size type) ¶(eql :float64)) &key) ¶(eql :float32)) &key) ¶(eql :s64)) &key) ¶(eql :s32)) &key) ¶(eql :s16)) &key) ¶(eql :s8)) &key) ¶(eql :u64)) &key) ¶(eql :u32)) &key) ¶(eql :u16)) &key) ¶(eql :u8)) &key) ¶(eql binary-io.common-datatypes::unsigned-integer)) &key bits) ¶symbol) &key) ¶Defaults to low level object size.
Write a value of the given type to the stream.
(eql binary-io.common-datatypes:8bit-string)) stream1 value2 &key length terminator) ¶(eql binary-io.common-datatypes:ucs-2-terminated-string)) stream1 value2 &key terminator) ¶(eql binary-io.common-datatypes:ucs-2-string)) stream1 value2 &key length) ¶(eql binary-io.common-datatypes:ucs-2-char-little-endian)) stream1 value2 &key) ¶(eql binary-io.common-datatypes:ucs-2-char-big-endian)) stream1 value2 &key) ¶(eql binary-io.common-datatypes:ucs-2-char)) stream1 value2 &key swap) ¶(eql binary-io.common-datatypes:iso-8859-1-terminated-string)) stream1 value2 &key terminator) ¶(eql binary-io.common-datatypes:iso-8859-1-string)) stream1 value2 &key length) ¶(eql binary-io.common-datatypes:iso-8859-1-char)) stream1 value2 &key) ¶(eql binary-io.common-datatypes:generic-terminated-string)) stream1 value2 &key terminator character-type) ¶(eql binary-io.common-datatypes:generic-string)) stream1 value2 &key length character-type) ¶(eql :vector)) stream1 value2 &key size type) ¶(eql :float64)) stream1 value2 &key) ¶(eql :float32)) stream1 value2 &key) ¶(eql :s64)) stream19 value20 &key) ¶(eql :s32)) stream19 value20 &key) ¶(eql :s16)) stream19 value20 &key) ¶(eql :s8)) stream19 value20 &key) ¶(eql :u64)) stream1 value2 &key) ¶(eql :u32)) stream1 value2 &key) ¶(eql :u16)) stream1 value2 &key) ¶(eql :u8)) stream1 value2 &key) ¶(eql binary-io.common-datatypes::unsigned-integer)) stream1 value2 &key bits) ¶symbol) stream value &key) ¶Write a VALUE of the given TYPE to the STREAM at OFFSET.
(eql :vector)) (stream mmap-stream) offset value &key type) ¶(eql :float64)) (stream mmap-stream) offset value &key) ¶(eql :float32)) (stream mmap-stream) offset value &key) ¶(eql :s64)) (stream1 mmap-stream) offset3 value2 &key) ¶(eql :s32)) (stream1 mmap-stream) offset3 value2 &key) ¶(eql :s16)) (stream1 mmap-stream) offset3 value2 &key) ¶(eql :s8)) (stream1 mmap-stream) offset3 value2 &key) ¶(eql :u64)) (stream1 mmap-stream) offset3 value2 &key) ¶(eql :u32)) (stream1 mmap-stream) offset3 value2 &key) ¶(eql :u16)) (stream1 mmap-stream) offset3 value2 &key) ¶(eql :u8)) (stream1 mmap-stream) offset3 value2 &key) ¶fundamental-binary-stream.
close.
mmap-stream-address.
mmap-stream-fd.
read-value-at.
read-value-at.
read-value-at.
read-value-at.
read-value-at.
read-value-at.
read-value-at.
read-value-at.
read-value-at.
read-value-at.
read-value-at.
write-value-at.
write-value-at.
write-value-at.
write-value-at.
write-value-at.
write-value-at.
write-value-at.
write-value-at.
write-value-at.
write-value-at.
write-value-at.
:fd
This slot is read-only.
:address
This slot is read-only.
Like all slots but works while compiling a new class before slots and superclasses have been saved.
Is alist a ((:reader...) (:writer...) (:size...)) kind of alist.
mmap-stream)) ¶automatically generated reader method
mmap-stream)) ¶automatically generated reader method
Returns the octet size of an object.
+.
:most-specific-first
Fill in the slots of object from stream.
progn.
:most-specific-last
Write out the slots of object to the stream.
progn.
:most-specific-last
| Jump to: | A B C D F G I M N O P R S T U W |
|---|
| Jump to: | A B C D F G I M N O P R S T U W |
|---|
| Jump to: | *
+
A C F S |
|---|
| Jump to: | *
+
A C F S |
|---|
| Jump to: | B C F M P S |
|---|
| Jump to: | B C F M P S |
|---|