Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The nibbles-streams Reference Manual
This is the nibbles-streams Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 06:44:51 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The nibbles-streams Reference Manual, Up: The nibbles-streams Reference Manual [Contents][Index]
1 Introduction
nibbles-streams
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.
Supported element types
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]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 nibbles-streams
Proof of concept for lossless audio compressor
- Author
Vasily Postnicov <shamaz.mazum@gmail.com>
- License
2-clause BSD
- Version
0.1
- Dependencies
- trivial-gray-streams (system).
- nibbles (system).
- serapeum (system).
- Source
- Child Components
- package.lisp (file).
- signed-octets.lisp (file).
- nibbles-streams.lisp (file).
Next: Packages, Previous: Systems, Up: The nibbles-streams Reference Manual [Contents][Index]
3 Files
Files are sorted by type and then listed depth-first from the systems components trees.
3.1 Lisp
- nibbles-streams/nibbles-streams.asd
- nibbles-streams/package.lisp
- nibbles-streams/signed-octets.lisp
- nibbles-streams/nibbles-streams.lisp
Next: nibbles-streams/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
3.1.1 nibbles-streams/nibbles-streams.asd
- Source
- Parent Component
nibbles-streams (system).
- ASDF Systems
Next: nibbles-streams/signed-octets.lisp, Previous: nibbles-streams/nibbles-streams.asd, Up: Lisp [Contents][Index]
3.1.2 nibbles-streams/package.lisp
- Source
- Parent Component
nibbles-streams (system).
- Packages
Next: nibbles-streams/nibbles-streams.lisp, Previous: nibbles-streams/package.lisp, Up: Lisp [Contents][Index]
3.1.3 nibbles-streams/signed-octets.lisp
- Dependency
package.lisp (file).
- Source
- Parent Component
nibbles-streams (system).
- Internals
- read-sb8 (function).
- read-sb8-sequence (function).
- sb8->ub8 (function).
- ub8->sb8 (function).
- write-sb8 (function).
- write-sb8-sequence (function).
Previous: nibbles-streams/signed-octets.lisp, Up: Lisp [Contents][Index]
3.1.4 nibbles-streams/nibbles-streams.lisp
- Dependency
signed-octets.lisp (file).
- Source
- Parent Component
nibbles-streams (system).
- Public Interface
- initialize-instance (method).
- make-load-form (method).
- nibbles-input-stream (class).
- nibbles-output-stream (class).
- nibbles-stream (class).
- nibbles-stream-element-type (reader method).
- (setf nibbles-stream-element-type) (writer method).
- (setf nibbles-stream-element-type) (method).
- nibbles-stream-endianness (reader method).
- (setf nibbles-stream-endianness) (writer method).
- (setf nibbles-stream-endianness) (method).
- nibbles-stream-error (condition).
- print-object (method).
- stream-clear-input (method).
- stream-clear-output (method).
- stream-element-type (method).
- stream-finish-output (method).
- stream-force-output (method).
- stream-read-byte (method).
- stream-read-sequence (method).
- stream-write-byte (method).
- stream-write-sequence (method).
- Internals
- %constructor= (method).
- *function-db* (special variable).
- constructor-values/generic (method).
- copy-db-entry (function).
- db-entry (function).
- db-entry (structure).
- db-entry-byte-reader (reader).
- db-entry-byte-writer (reader).
- db-entry-element-type (reader).
- db-entry-endianness (reader).
- db-entry-sequence-reader (reader).
- db-entry-sequence-writer (reader).
- find-entry (function).
- nibbles-functions (function).
- nibbles-stream-stream (reader method).
- read-only-struct-slot-names (method).
- typesequalp (function).
Next: Definitions, Previous: Files, Up: The nibbles-streams Reference Manual [Contents][Index]
4 Packages
Packages are listed by definition order.
4.1 nibbles-streams
- Source
- Use List
common-lisp.
- Public Interface
- nibbles-input-stream (class).
- nibbles-output-stream (class).
- nibbles-stream (class).
- nibbles-stream-element-type (generic reader).
- (setf nibbles-stream-element-type) (generic function).
- nibbles-stream-endianness (generic reader).
- (setf nibbles-stream-endianness) (generic function).
- nibbles-stream-error (condition).
- Internals
- *function-db* (special variable).
- copy-db-entry (function).
- db-entry (function).
- db-entry (structure).
- db-entry-byte-reader (reader).
- db-entry-byte-writer (reader).
- db-entry-element-type (reader).
- db-entry-endianness (reader).
- db-entry-sequence-reader (reader).
- db-entry-sequence-writer (reader).
- find-entry (function).
- nibbles-functions (function).
- nibbles-stream-stream (generic reader).
- read-sb8 (function).
- read-sb8-sequence (function).
- sb8->ub8 (function).
- typesequalp (function).
- ub8->sb8 (function).
- write-sb8 (function).
- write-sb8-sequence (function).
Next: Indexes, Previous: Packages, Up: The nibbles-streams Reference Manual [Contents][Index]
5 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
5.1 Public Interface
Next: Standalone methods, Previous: Public Interface, Up: Public Interface [Contents][Index]
5.1.1 Generic functions
- Generic Reader: nibbles-stream-element-type (object) ¶
-
- Package
- Methods
- Reader Method: nibbles-stream-element-type ((nibbles-stream nibbles-stream)) ¶
-
Element type of nibble-stream. Setfable.
- Source
- Target Slot
- Generic Function: (setf nibbles-stream-element-type) (object) ¶
-
- Package
- Methods
- Writer Method: (setf nibbles-stream-element-type) :before ((stream nibbles-stream)) ¶
-
- Source
- Target Slot
- Method: (setf nibbles-stream-element-type) ((nibbles-stream nibbles-stream)) ¶
-
Element type of nibble-stream. Setfable.
- Source
- Generic Reader: nibbles-stream-endianness (object) ¶
-
- Package
- Methods
- Reader Method: nibbles-stream-endianness ((nibbles-stream nibbles-stream)) ¶
-
Endianness of the stream. Can be :LITTLE or :BIG
- Source
- Target Slot
- Generic Function: (setf nibbles-stream-endianness) (object) ¶
-
- Package
- Methods
- Writer Method: (setf nibbles-stream-endianness) :before ((stream nibbles-stream)) ¶
-
- Source
- Target Slot
- Method: (setf nibbles-stream-endianness) ((nibbles-stream nibbles-stream)) ¶
-
Endianness of the stream. Can be :LITTLE or :BIG
- Source
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
5.1.2 Standalone methods
- Method: initialize-instance :after ((nibbles-stream nibbles-stream) &key element-type &allow-other-keys) ¶
-
- Source
- Method: stream-clear-input ((stream nibbles-input-stream)) ¶
-
- Package
sb-gray.
- Source
- Method: stream-clear-output ((stream nibbles-output-stream)) ¶
-
- Package
sb-gray.
- Source
- Method: stream-element-type ((stream nibbles-stream)) ¶
-
- Source
- Method: stream-finish-output ((stream nibbles-output-stream)) ¶
-
- Package
sb-gray.
- Source
- Method: stream-force-output ((stream nibbles-output-stream)) ¶
-
- Package
sb-gray.
- Source
- Method: stream-read-byte ((stream nibbles-input-stream)) ¶
-
- Package
sb-gray.
- Source
- Method: stream-read-sequence ((stream nibbles-input-stream) sequence start end &key &allow-other-keys) ¶
-
- Package
trivial-gray-streams.
- Source
- Method: stream-write-byte ((stream nibbles-output-stream) byte) ¶
-
- Package
sb-gray.
- Source
- Method: stream-write-sequence ((stream nibbles-input-stream) sequence start end &key &allow-other-keys) ¶
-
- Package
trivial-gray-streams.
- Source
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
5.1.3 Conditions
- Condition: nibbles-stream-error ¶
-
Condition class realted to nibbles-stream.
- Package
- Source
- Direct superclasses
simple-error.
Previous: Conditions, Up: Public Interface [Contents][Index]
5.1.4 Classes
- Class: nibbles-input-stream ¶
-
Input nibbles stream.
- Package
- Source
- Direct superclasses
- fundamental-binary-input-stream.
- nibbles-stream.
- Direct methods
- Class: nibbles-output-stream ¶
-
Output nibbles stream.
- Package
- Source
- Direct superclasses
- fundamental-binary-output-stream.
- nibbles-stream.
- Direct methods
- Class: nibbles-stream ¶
-
Generic nibbles stream. Not to be instantiated.
- Package
- Source
- Direct superclasses
fundamental-binary-stream.
- Direct subclasses
- Direct methods
- Direct slots
- Slot: element-type ¶
-
Element type of nibble-stream. Setfable.
- Initargs
:element-type
- Readers
- Writers
- Slot: endianness ¶
-
Endianness of the stream. Can be :LITTLE or :BIG
- Type
(member :big :little)
- Initform
:little
- Initargs
:endianness
- Readers
- Writers
- Slot: stream ¶
-
Underlying stream. Must be specified at creation time.
- Package
common-lisp.
- Type
stream
- Initform
(error "specify underlying stream")
- Initargs
:stream
- Readers
- Writers
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
5.2 Internals
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
5.2.1 Special variables
- Special Variable: *function-db* ¶
-
- Package
- Source
Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]
5.2.2 Ordinary functions
- Function: copy-db-entry (db-entry1 &key endianness element-type byte-reader sequence-reader byte-writer sequence-writer) ¶
-
Copy an instance of DB-ENTRY, optionally overriding some or all of its slots.
- Package
- Source
- Function: db-entry (endianness element-type byte-reader sequence-reader byte-writer sequence-writer) ¶
-
- Package
- Source
- Reader: db-entry-byte-reader (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: db-entry-byte-writer (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: db-entry-element-type (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: db-entry-endianness (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: db-entry-sequence-reader (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: db-entry-sequence-writer (instance) ¶
-
- Package
- Source
- Target Slot
- Function: find-entry (endianness type) ¶
-
- Package
- Source
- Function: nibbles-functions () ¶
-
- Package
- Source
- Function: read-sb8 (stream &optional eof-error-p eof-value) ¶
-
- Package
- Source
- Function: read-sb8-sequence (seq stream &key start end) ¶
-
- Package
- Source
- Function: sb8->ub8 (byte) ¶
-
- Package
- Source
- Function: typesequalp (t1 t2) ¶
-
- Package
- Source
- Function: ub8->sb8 (byte) ¶
-
- Package
- Source
- Function: write-sb8 (byte stream) ¶
-
- Package
- Source
- Function: write-sb8-sequence (seq stream &key start end) ¶
-
- Package
- Source
Next: Standalone methods, Previous: Ordinary functions, Up: Internals [Contents][Index]
5.2.3 Generic functions
- Generic Reader: nibbles-stream-stream (object) ¶
-
- Package
- Methods
- Reader Method: nibbles-stream-stream ((nibbles-stream nibbles-stream)) ¶
-
Underlying stream. Must be specified at creation time.
- Source
- Target Slot
Next: Structures, Previous: Generic functions, Up: Internals [Contents][Index]
5.2.4 Standalone methods
Previous: Standalone methods, Up: Internals [Contents][Index]
5.2.5 Structures
- Structure: db-entry ¶
-
- Package
- Source
- Direct superclasses
%read-only-struct.
- Direct methods
- Direct slots
- Slot: endianness ¶
-
- Type
(member :big :little)
- Initform
(alexandria:required-argument (quote nibbles-streams::endianness))
- Readers
- Writers
This slot is read-only.
- Slot: element-type ¶
-
- Initform
(alexandria:required-argument (quote nibbles-streams::element-type))
- Readers
- Writers
This slot is read-only.
- Slot: byte-reader ¶
-
- Type
function
- Initform
(alexandria:required-argument (quote nibbles-streams::byte-reader))
- Readers
- Writers
This slot is read-only.
- Slot: sequence-reader ¶
-
- Type
function
- Initform
(alexandria:required-argument (quote nibbles-streams::sequence-reader))
- Readers
- Writers
This slot is read-only.
- Slot: byte-writer ¶
-
- Type
function
- Initform
(alexandria:required-argument (quote nibbles-streams::byte-writer))
- Readers
- Writers
This slot is read-only.
- Slot: sequence-writer ¶
-
- Type
function
- Initform
(alexandria:required-argument (quote nibbles-streams::sequence-writer))
- Readers
- Writers
This slot is read-only.
Previous: Definitions, Up: The nibbles-streams Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| 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]
A.3 Variables
| Jump to: | *
B E S |
|---|
| Jump to: | *
B E S |
|---|
A.4 Data types
| Jump to: | C D F N P S |
|---|
| Jump to: | C D F N P S |
|---|