Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the nibbles-streams Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:27:20 2022 GMT+0.
Next: Systems, Previous: The nibbles-streams Reference Manual, Up: The nibbles-streams Reference Manual [Contents][Index]
Nibbles-streams is a wrapper around nibbles
which allows you to create input
and output binary streams with changeable element type and endianness.
An example:
(flexi-streams:with-output-to-sequence (stream)
;; Open little endian nibbles-stream with underlying stream's element-type
(let ((output (make-instance 'nibbles-streams:nibbles-output-stream
:stream stream)))
(write-byte 2 output)
(write-sequence #(1 2 3) output)
;; Change element-type and endianness
(setf (nibbles-streams:nibbles-stream-element-type output)
'(signed-byte 16)
(nibbles-streams:nibbles-stream-endianness output)
:big)
(write-byte 1000 output)
(write-sequence #(-1 -2001 300) output)))
=> #(2 1 2 3 3 232 255 255 248 47 1 44)
The package nibble-streams
export two types of streams: nibbles-input-stream
and nibbles-output-stream
, accessors nibbles-stream-element-type
and
nibbles-stream-endianness
and a condition nibbles-stream-error
which is
signalled when a wrong element type or endianness is specified.
These element types are supported:
(unsigned-byte 8)
(unsigned-byte 16)
(unsigned-byte 32)
(unsigned-byte 64)
(signed-byte 8)
(signed-byte 16)
(signed-byte 32)
(signed-byte 64)
Next: Files, Previous: Introduction, Up: The nibbles-streams Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Proof of concept for lossless audio compressor
Vasily Postnicov <shamaz.mazum@gmail.com>
2-clause BSD
0.1
Next: Packages, Previous: Systems, Up: The nibbles-streams Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: nibbles-streams/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
nibbles-streams (system).
Next: nibbles-streams/signed-octets.lisp, Previous: nibbles-streams/nibbles-streams.asd, Up: Lisp [Contents][Index]
nibbles-streams (system).
Next: nibbles-streams/nibbles-streams.lisp, Previous: nibbles-streams/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
nibbles-streams (system).
Previous: nibbles-streams/signed-octets.lisp, Up: Lisp [Contents][Index]
signed-octets.lisp (file).
nibbles-streams (system).
Next: Definitions, Previous: Files, Up: The nibbles-streams Reference Manual [Contents][Index]
Packages are listed by definition order.
common-lisp.
Next: Indexes, Previous: Packages, Up: The nibbles-streams Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Standalone methods, Previous: Public Interface, Up: Public Interface [Contents][Index]
Element type of nibble-stream. Setfable.
Element type of nibble-stream. Setfable.
Endianness of the stream. Can be :LITTLE or :BIG
Endianness of the stream. Can be :LITTLE or :BIG
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
sb-gray.
sb-gray.
sb-gray.
sb-gray.
sb-gray.
trivial-gray-streams.
sb-gray.
trivial-gray-streams.
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
Condition class realted to nibbles-stream.
simple-error.
Previous: Conditions, Up: Public Interface [Contents][Index]
Input nibbles stream.
Output nibbles stream.
Generic nibbles stream. Not to be instantiated.
fundamental-binary-stream.
Element type of nibble-stream. Setfable.
:element-type
Endianness of the stream. Can be :LITTLE or :BIG
(member :big :little)
:little
:endianness
Underlying stream. Must be specified at creation time.
common-lisp.
stream
(error "specify underlying stream")
:stream
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]
Copy an instance of DB-ENTRY, optionally overriding some or all of its slots.
Next: Standalone methods, Previous: Ordinary functions, Up: Internals [Contents][Index]
Underlying stream. Must be specified at creation time.
Next: Structures, Previous: Generic functions, Up: Internals [Contents][Index]
Previous: Standalone methods, Up: Internals [Contents][Index]
%read-only-struct.
(member :big :little)
(alexandria:required-argument (quote nibbles-streams::endianness))
This slot is read-only.
(alexandria:required-argument (quote nibbles-streams::element-type))
This slot is read-only.
function
(alexandria:required-argument (quote nibbles-streams::byte-reader))
This slot is read-only.
function
(alexandria:required-argument (quote nibbles-streams::sequence-reader))
This slot is read-only.
function
(alexandria:required-argument (quote nibbles-streams::byte-writer))
This slot is read-only.
function
(alexandria:required-argument (quote nibbles-streams::sequence-writer))
This slot is read-only.
Previous: Definitions, Up: The nibbles-streams Reference Manual [Contents][Index]
Jump to: | %
(
C D F G I M N P R S T U W |
---|
Jump to: | %
(
C D F G I M N P R S T U W |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
B E S |
---|
Jump to: | *
B E S |
---|
Jump to: | C D F N P S |
---|
Jump to: | C D F N P S |
---|