This is the trivial-bit-streams Reference Manual, version 0.1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:55:53 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-bit-streams
Trivial bit streams
Dmitry Ignatiev <lovesan.ru@gmail.com>
Dmitry Ignatiev <lovesan.ru@gmail.com>
MIT
0.1.2
trivial-gray-streams
(system).
src
(module).
Modules are listed depth-first from the system components tree.
trivial-bit-streams/src
trivial-bit-streams
(system).
package.lisp
(file).
classes.lisp
(file).
methods.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-bit-streams/trivial-bit-streams.asd
trivial-bit-streams/src/package.lisp
trivial-bit-streams/src/classes.lisp
trivial-bit-streams/src/methods.lisp
trivial-bit-streams/trivial-bit-streams.asd
trivial-bit-streams
(system).
trivial-bit-streams/src/classes.lisp
package.lisp
(file).
src
(module).
*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).
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).
trivial-bit-streams/src/methods.lisp
classes.lisp
(file).
src
(module).
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).
ensure-input
(function).
ensure-output
(function).
inc-bit-counter
(function).
Packages are listed by definition order.
trivial-bit-streams
tbs
trivial-bs
common-lisp
.
trivial-gray-streams
.
*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
(generic reader).
(setf bit-stream-buffer-overflow-buffer-size)
(generic writer).
bit-stream-buffer-overflow-index
(generic reader).
(setf bit-stream-buffer-overflow-index)
(generic writer).
bit-stream-byte-counter
(function).
bit-stream-closed-error
(condition).
bit-stream-end-of-file
(condition).
bit-stream-error
(condition).
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).
with-bit-input-stream
(macro).
with-bit-output-stream
(macro).
write-bit
(function).
write-bits
(function).
write-octet
(function).
write-octet-vector
(function).
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
(generic reader).
(setf bit-stream-callback)
(generic writer).
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).
ensure-input
(function).
ensure-output
(function).
inc-bit-counter
(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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
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.
Default buffer size for input bit stream, in octets.
Default buffer size for output bit stream, in octets.
Retrieves total number of bytes processed by bit stream
Resets stream’s internal bit counters, effectively invalidating current contents of the stream’s buffer.
Invokes bit output stream’s callback and resets stream’s internal bit counters.
Pad the output stream with BITs to reach the byte alignment. Returns written bits.
Retrieves the next bit from bit input 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.
Retrieves the next non-packed octet from the bit input stream.
Destructively modifies VECTOR by reading non-packed octets from bit input stream. Returns the total number of octets readen.
Retrieves bits needed to reach byte alignment from the input stream. May read 0 to 7 bits.
Writes a single bit to the bit output stream.
Writes a sequence of bits to the bit output stream
starting from the least significant bit of the supplied integer.
Writes a single non-packed octet to the bit output stream.
Writes a vector of non-packed octets to the bit output stream.
bit-stream-buffer-overflow
)) ¶bit-stream-buffer-overflow
)) ¶bit-stream-buffer-overflow
)) ¶bit-stream-buffer-overflow
)) ¶bit-input-stream
)) ¶sb-gray
.
bit-output-stream
)) ¶sb-gray
.
bit-stream
)) ¶bit-output-stream
)) ¶sb-gray
.
bit-output-stream
)) ¶sb-gray
.
bit-input-stream
)) ¶sb-gray
.
bit-input-stream
)) ¶sb-gray
.
bit-input-stream
) sequence start end &key) ¶trivial-gray-streams
.
bit-output-stream
) integer) ¶sb-gray
.
bit-output-stream
) sequence start end &key) ¶trivial-gray-streams
.
Represents a condition when callback of a bit input stream returned value that is greater than the size of the internal buffer
Represents a condition when someone is trying to perform an i/o operation on closed bit stream.
Represents a condition when no more bits are availiable to read from bit input stream
bit-stream-error
.
end-of-file
.
Represents a bit stream i/o error
stream-error
.
Represents the state of the bit input stream.
bit-stream
.
fundamental-binary-input-stream
.
trivial-gray-stream-mixin
.
Initarg | Value |
---|---|
:buffer-size | *default-bit-output-stream-buffer-size* |
:callback | (lambda (&rest args) (declare (ignore args)) (values)) |
Represents the state of the bit output stream.
bit-stream
.
fundamental-binary-output-stream
.
trivial-gray-stream-mixin
.
Initarg | Value |
---|---|
:buffer-size | *default-bit-input-stream-buffer-size* |
:callback | (lambda (&rest args) (declare (ignore args)) 0) |
A mixin, that describes the state of a bit stream. Not to be instantiated.
fundamental-binary-stream
.
trivial-bit-streams::bit-stream-core
function
:callback
trivial-bit-streams::positive-fixnum
:buffer-size
end
.
ibit
.
bit-stream
)) ¶automatically generated reader method
bit-stream
)) ¶automatically generated writer method
structure-object
.
trivial-bit-streams::simple-ub8-vector
trivial-bit-streams::non-negative-fixnum
0
trivial-bit-streams::non-negative-fixnum
0
trivial-bit-streams::bit-counter
0
unsigned-byte
0
Jump to: | (
B C E F G I M P R S W |
---|
Jump to: | (
B C E F G I M P R S W |
---|
Jump to: | *
B C E I S |
---|
Jump to: | *
B C E I S |
---|
Jump to: | B C F M N P S T U |
---|
Jump to: | B C F M N P S T U |
---|