The trivial-bit-streams Reference Manual

4.1.1 trivial-bit-streams/trivial-bit-streams.asd

Source

trivial-bit-streams.asd.

Parent Component

trivial-bit-streams (system).

ASDF Systems

trivial-bit-streams.

---

4.1.2 trivial-bit-streams/src/package.lisp

Source

trivial-bit-streams.asd.

Parent Component

src (module).

Packages

trivial-bit-streams.

---

4.1.3 trivial-bit-streams/src/classes.lisp

Dependency

package.lisp (file).

Source

trivial-bit-streams.asd.

Parent Component

src (module).

Public Interface

• *bit-stream-bit-io* (special variable).
• *default-bit-input-stream-buffer-size* (special variable).
• *default-bit-output-stream-buffer-size* (special variable).
• bit-input-stream (class).
• bit-output-stream (class).
• bit-stream (class).
• bit-stream-buffer-overflow (condition).
• bit-stream-buffer-overflow-buffer-size (reader method).
• (setf bit-stream-buffer-overflow-buffer-size) (writer method).
• bit-stream-buffer-overflow-index (reader method).
• (setf bit-stream-buffer-overflow-index) (writer method).
• bit-stream-closed-error (condition).
• bit-stream-end-of-file (condition).
• bit-stream-error (condition).

Internals

• bit-counter (type).
• bit-input-stream-core (structure).
• bit-input-stream-core-buffer (function).
• (setf bit-input-stream-core-buffer) (function).
• bit-input-stream-core-byte-counter (function).
• (setf bit-input-stream-core-byte-counter) (function).
• bit-input-stream-core-end (function).
• (setf bit-input-stream-core-end) (function).
• bit-input-stream-core-ibit (function).
• (setf bit-input-stream-core-ibit) (function).
• bit-input-stream-core-ibyte (function).
• (setf bit-input-stream-core-ibyte) (function).
• bit-input-stream-core-p (function).
• bit-output-stream-core (structure).
• bit-output-stream-core-buffer (function).
• (setf bit-output-stream-core-buffer) (function).
• bit-output-stream-core-byte-counter (function).
• (setf bit-output-stream-core-byte-counter) (function).
• bit-output-stream-core-end (function).
• (setf bit-output-stream-core-end) (function).
• bit-output-stream-core-ibit (function).
• (setf bit-output-stream-core-ibit) (function).
• bit-output-stream-core-ibyte (function).
• (setf bit-output-stream-core-ibyte) (function).
• bit-output-stream-core-p (function).
• bit-stream-callback (reader method).
• (setf bit-stream-callback) (writer method).
• bit-stream-core (structure).
• bit-stream-core-buffer (reader).
• (setf bit-stream-core-buffer) (writer).
• bit-stream-core-byte-counter (reader).
• (setf bit-stream-core-byte-counter) (writer).
• bit-stream-core-end (reader).
• (setf bit-stream-core-end) (writer).
• bit-stream-core-ibit (reader).
• (setf bit-stream-core-ibit) (writer).
• bit-stream-core-ibyte (reader).
• (setf bit-stream-core-ibyte) (writer).
• bit-stream-core-p (function).
• copy-bit-input-stream-core (function).
• copy-bit-output-stream-core (function).
• copy-bit-stream-core (function).
• make-bit-input-stream-core (function).
• make-bit-output-stream-core (function).
• non-negative-fixnum (type).
• positive-fixnum (type).
• simple-ub8-vector (type).
• ub4 (type).
• ub8 (type).

---

4.1.4 trivial-bit-streams/src/methods.lisp

Dependency

classes.lisp (file).

Source

trivial-bit-streams.asd.

Parent Component

src (module).

Public Interface

• bit-stream-byte-counter (function).
• flush-bit-input-stream (function).
• flush-bit-output-stream (function).
• make-blackhole-output-callback (function).
• make-eof-input-callback (function).
• make-stream-input-callback (function).
• make-stream-output-callback (function).
• pad-to-byte-alignment (function).
• read-bit (function).
• read-bits (function).
• read-octet (function).
• read-octet-vector (function).
• read-to-byte-alignment (function).
• shared-initialize (method).
• shared-initialize (method).
• stream-clear-input (method).
• stream-clear-output (method).
• stream-element-type (method).
• stream-finish-output (method).
• stream-force-output (method).
• stream-listen (method).
• stream-read-byte (method).
• stream-read-sequence (method).
• stream-write-byte (method).
• stream-write-sequence (method).
• with-bit-input-stream (macro).
• with-bit-output-stream (macro).
• write-bit (function).
• write-bits (function).
• write-octet (function).
• write-octet-vector (function).

Internals

• ensure-input (function).
• ensure-output (function).
• inc-bit-counter (function).

---

6.1.1 Special variables

Special Variable: *bit-stream-bit-io* ¶

In case when this variable is bound to NIL, WRITE-BYTE/READ-BYTE and WRITE-SEQUENCE/READ-SEQUENCE will behave like WRITE-OCTET/READ-OCTET and WRITE-OCTET-VECTOR/READ-OCTET-VECTOR while operating on bit streams. Otherwise, they will treat supplied parameter as a single bit or a sequence of bits correspondingly.

Package

trivial-bit-streams.

Source

classes.lisp.

Special Variable: *default-bit-input-stream-buffer-size* ¶

Default buffer size for input bit stream, in octets.

Package

trivial-bit-streams.

Source

classes.lisp.

Special Variable: *default-bit-output-stream-buffer-size* ¶

Default buffer size for output bit stream, in octets.

Package

trivial-bit-streams.

Source

classes.lisp.

---

6.1.2 Macros

Macro: with-bit-input-stream ((var &key callback buffer-size) &body body) ¶

Package

trivial-bit-streams.

Source

methods.lisp.

Macro: with-bit-output-stream ((var &key callback buffer-size) &body body) ¶

Package

trivial-bit-streams.

Source

methods.lisp.

---

6.1.3 Ordinary functions

Function: bit-stream-byte-counter (bit-stream) ¶

Retrieves total number of bytes processed by bit stream

Package

trivial-bit-streams.

Source

methods.lisp.

Function: flush-bit-input-stream (bit-stream) ¶

Resets stream’s internal bit counters, effectively invalidating current contents of the stream’s buffer.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: flush-bit-output-stream (bit-stream) ¶

Invokes bit output stream’s callback and resets stream’s internal bit counters.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: make-blackhole-output-callback () ¶

Package

trivial-bit-streams.

Source

methods.lisp.

Function: make-eof-input-callback () ¶

Package

trivial-bit-streams.

Source

methods.lisp.

Function: make-stream-input-callback (stream) ¶

Package

trivial-bit-streams.

Source

methods.lisp.

Function: make-stream-output-callback (stream) ¶

Package

trivial-bit-streams.

Source

methods.lisp.

Function: pad-to-byte-alignment (bit bit-stream) ¶

Pad the output stream with BITs to reach the byte alignment. Returns written bits.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: read-bit (bit-stream &optional eof-error-p eof-value) ¶

Retrieves the next bit from bit input stream.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: read-bits (bits-to-read bit-stream) ¶

Retrieves the next BITS-TO-READ bits from bit input stream. Returns an integer which is filled with bits from the stream starting from the least significant bit, and the total count of bits readen, which may be less than the requested count.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: read-octet (bit-stream &optional eof-error-p eof-value) ¶

Retrieves the next non-packed octet from the bit input stream.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: read-octet-vector (vector bit-stream &key start end) ¶

Destructively modifies VECTOR by reading non-packed octets from bit input stream. Returns the total number of octets readen.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: read-to-byte-alignment (bit-stream &optional eof-error-p eof-value) ¶

Retrieves bits needed to reach byte alignment from the input stream. May read 0 to 7 bits.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: write-bit (bit bit-stream) ¶

Writes a single bit to the bit output stream.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: write-bits (bits bits-to-write bit-stream) ¶

Writes a sequence of bits to the bit output stream
starting from the least significant bit of the supplied integer.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: write-octet (octet bit-stream) ¶

Writes a single non-packed octet to the bit output stream.

Package

trivial-bit-streams.

Source

methods.lisp.

Function: write-octet-vector (vector bit-stream &key start end) ¶

Writes a vector of non-packed octets to the bit output stream.

Package

trivial-bit-streams.

Source

methods.lisp.

---

6.1.4 Generic functions

Generic Reader: bit-stream-buffer-overflow-buffer-size (condition) ¶

Generic Writer: (setf bit-stream-buffer-overflow-buffer-size) (condition) ¶

Package

trivial-bit-streams.

Methods

Reader Method: bit-stream-buffer-overflow-buffer-size ((condition bit-stream-buffer-overflow)) ¶

Writer Method: (setf bit-stream-buffer-overflow-buffer-size) ((condition bit-stream-buffer-overflow)) ¶

Source

classes.lisp.

Target Slot

buffer-size.

Generic Reader: bit-stream-buffer-overflow-index (condition) ¶

Generic Writer: (setf bit-stream-buffer-overflow-index) (condition) ¶

Package

trivial-bit-streams.

Methods

Reader Method: bit-stream-buffer-overflow-index ((condition bit-stream-buffer-overflow)) ¶

Writer Method: (setf bit-stream-buffer-overflow-index) ((condition bit-stream-buffer-overflow)) ¶

Source

classes.lisp.

Target Slot

index.

---

6.1.5 Standalone methods

Method: shared-initialize :after ((stream bit-output-stream) slot-names &key buffer-size callback) ¶

Source

methods.lisp.

Method: shared-initialize :after ((stream bit-input-stream) slot-names &key buffer-size callback) ¶

Source

methods.lisp.

Method: stream-clear-input ((stream bit-input-stream)) ¶

Package

sb-gray.

Source

methods.lisp.

Method: stream-clear-output ((stream bit-output-stream)) ¶

Package

sb-gray.

Source

methods.lisp.

Method: stream-element-type ((stream bit-stream)) ¶

Source

methods.lisp.

Method: stream-finish-output ((stream bit-output-stream)) ¶

Package

sb-gray.

Source

methods.lisp.

Method: stream-force-output ((stream bit-output-stream)) ¶

Package

sb-gray.

Source

methods.lisp.

Method: stream-listen ((stream bit-input-stream)) ¶

Package

sb-gray.

Source

methods.lisp.

Method: stream-read-byte ((stream bit-input-stream)) ¶

Package

sb-gray.

Source

methods.lisp.

Method: stream-read-sequence ((stream bit-input-stream) sequence start end &key) ¶

Package

trivial-gray-streams.

Source

methods.lisp.

Method: stream-write-byte ((stream bit-output-stream) integer) ¶

Package

sb-gray.

Source

methods.lisp.

Method: stream-write-sequence ((stream bit-output-stream) sequence start end &key) ¶

Package

trivial-gray-streams.

Source

methods.lisp.

---

6.1.6 Conditions

Condition: bit-stream-buffer-overflow ¶

Represents a condition when callback of a bit input stream returned value that is greater than the size of the internal buffer

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

bit-stream-error.

Direct methods

• (setf bit-stream-buffer-overflow-buffer-size).
• bit-stream-buffer-overflow-buffer-size.
• (setf bit-stream-buffer-overflow-index).
• bit-stream-buffer-overflow-index.

Direct slots

Slot: index ¶

Initargs

:index

Readers

bit-stream-buffer-overflow-index.

Writers

(setf bit-stream-buffer-overflow-index).

Slot: buffer-size ¶

Initargs

:buffer-size

Readers

bit-stream-buffer-overflow-buffer-size.

Writers

(setf bit-stream-buffer-overflow-buffer-size).

Condition: bit-stream-closed-error ¶

Represents a condition when someone is trying to perform an i/o operation on closed bit stream.

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

bit-stream-error.

Condition: bit-stream-end-of-file ¶

Represents a condition when no more bits are availiable to read from bit input stream

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

• bit-stream-error.
• end-of-file.

Condition: bit-stream-error ¶

Represents a bit stream i/o error

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

stream-error.

Direct subclasses

• bit-stream-buffer-overflow.
• bit-stream-closed-error.
• bit-stream-end-of-file.

---

6.1.7 Classes

Class: bit-input-stream ¶

Represents the state of the bit input stream.

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

• bit-stream.
• fundamental-binary-input-stream.
• trivial-gray-stream-mixin.

Direct methods

• shared-initialize.
• stream-clear-input.
• stream-listen.
• stream-read-byte.
• stream-read-sequence.

Direct Default Initargs

Initarg	Value
:buffer-size	*default-bit-output-stream-buffer-size*
:callback	(lambda (&rest args) (declare (ignore args)) (values))

Class: bit-output-stream ¶

Represents the state of the bit output stream.

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

• bit-stream.
• fundamental-binary-output-stream.
• trivial-gray-stream-mixin.

Direct methods

• shared-initialize.
• stream-clear-output.
• stream-finish-output.
• stream-force-output.
• stream-write-byte.
• stream-write-sequence.

Direct Default Initargs

Initarg	Value
:buffer-size	*default-bit-input-stream-buffer-size*
:callback	(lambda (&rest args) (declare (ignore args)) 0)

Class: bit-stream ¶

A mixin, that describes the state of a bit stream. Not to be instantiated.

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

fundamental-binary-stream.

Direct subclasses

• bit-input-stream.
• bit-output-stream.

Direct methods

• (setf bit-stream-callback).
• bit-stream-callback.
• stream-element-type.

Direct slots

Slot: core ¶

Type

trivial-bit-streams::bit-stream-core

Slot: callback ¶

Type

function

Initargs

:callback

Readers

bit-stream-callback.

Writers

(setf bit-stream-callback).

Slot: buffer-size ¶

Type

trivial-bit-streams::positive-fixnum

Initargs

:buffer-size

---

6.2.1 Ordinary functions

Function: bit-input-stream-core-buffer (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-input-stream-core-buffer) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-input-stream-core-byte-counter (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-input-stream-core-byte-counter) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-input-stream-core-end (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-input-stream-core-end) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-input-stream-core-ibit (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-input-stream-core-ibit) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-input-stream-core-ibyte (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-input-stream-core-ibyte) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-input-stream-core-p (object) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-output-stream-core-buffer (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-output-stream-core-buffer) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-output-stream-core-byte-counter (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-output-stream-core-byte-counter) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-output-stream-core-end (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-output-stream-core-end) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-output-stream-core-ibit (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-output-stream-core-ibit) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-output-stream-core-ibyte (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: (setf bit-output-stream-core-ibyte) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: bit-output-stream-core-p (object) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Reader: bit-stream-core-buffer (instance) ¶

Writer: (setf bit-stream-core-buffer) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Target Slot

buffer.

Reader: bit-stream-core-byte-counter (instance) ¶

Writer: (setf bit-stream-core-byte-counter) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Target Slot

byte-counter.

Reader: bit-stream-core-end (instance) ¶

Writer: (setf bit-stream-core-end) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Target Slot

end.

Reader: bit-stream-core-ibit (instance) ¶

Writer: (setf bit-stream-core-ibit) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Target Slot

ibit.

Reader: bit-stream-core-ibyte (instance) ¶

Writer: (setf bit-stream-core-ibyte) (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Target Slot

ibyte.

Function: bit-stream-core-p (object) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: copy-bit-input-stream-core (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: copy-bit-output-stream-core (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: copy-bit-stream-core (instance) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: ensure-input (bit-stream-core bit-stream) ¶

Package

trivial-bit-streams.

Source

methods.lisp.

Function: ensure-output (bit-stream-core callback) ¶

Package

trivial-bit-streams.

Source

methods.lisp.

Function: inc-bit-counter (bit-stream-core &optional n) ¶

Package

trivial-bit-streams.

Source

methods.lisp.

Function: make-bit-input-stream-core (buffer-size) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Function: make-bit-output-stream-core (buffer-size) ¶

Package

trivial-bit-streams.

Source

classes.lisp.

---

6.2.2 Generic functions

Generic Reader: bit-stream-callback (object) ¶

Package

trivial-bit-streams.

Methods

Reader Method: bit-stream-callback ((bit-stream bit-stream)) ¶

automatically generated reader method

Source

classes.lisp.

Target Slot

callback.

Generic Writer: (setf bit-stream-callback) (object) ¶

Package

trivial-bit-streams.

Methods

Writer Method: (setf bit-stream-callback) ((bit-stream bit-stream)) ¶

automatically generated writer method

Source

classes.lisp.

Target Slot

callback.

---

6.2.3 Structures

Structure: bit-input-stream-core ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

bit-stream-core.

Structure: bit-output-stream-core ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

bit-stream-core.

Structure: bit-stream-core ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Direct superclasses

structure-object.

Direct subclasses

• bit-input-stream-core.
• bit-output-stream-core.

Direct slots

Slot: buffer ¶

Type

trivial-bit-streams::simple-ub8-vector

Readers

bit-stream-core-buffer.

Writers

(setf bit-stream-core-buffer).

Slot: end ¶

Type

trivial-bit-streams::non-negative-fixnum

Initform

0

Readers

bit-stream-core-end.

Writers

(setf bit-stream-core-end).

Slot: ibyte ¶

Type

trivial-bit-streams::non-negative-fixnum

Initform

0

Readers

bit-stream-core-ibyte.

Writers

(setf bit-stream-core-ibyte).

Slot: ibit ¶

Type

trivial-bit-streams::bit-counter

Initform

0

Readers

bit-stream-core-ibit.

Writers

(setf bit-stream-core-ibit).

Slot: byte-counter ¶

Type

unsigned-byte

Initform

0

Readers

bit-stream-core-byte-counter.

Writers

(setf bit-stream-core-byte-counter).

---

6.2.4 Types

Type: bit-counter () ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Type: non-negative-fixnum () ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Type: positive-fixnum () ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Type: simple-ub8-vector () ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Type: ub4 () ¶

Package

trivial-bit-streams.

Source

classes.lisp.

Type: ub8 () ¶

Package

trivial-bit-streams.

Source

classes.lisp.

---