The trivial-bit-streams Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The trivial-bit-streams Reference Manual

This is the trivial-bit-streams Reference Manual, version 0.1.2, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:26:24 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Trivial-Bit-Streams

Trivial-bit-streams is a library which implements flexible buffered bit streams.

Input into INPUT-BIT-STREAM's buffer and output from OUTPUT-BIT-STREAM's one is managed through callbacks, so you can easily wrap bit streams around any desirable data type.

The library's single dependency is trivial-gray-streams library.

Usage

The bit streams wraps a `(simple-array (unsigned-byte 8) (,buffer-size))' buffer and reads bits from it. The underlying array is populated by the passed callback. The callback should also return the number of bytes read into the buffer. When the buffer is empty the callback is again called to refill the buffer.

NOTE: Bits are read from LSB to MSB. So (byte 254) reads: 0, 1, 1, 1, 1, 1, 1, 1.

Ex: Wrapping a stream.

Typical use is wrapping a `stream' with :element-type '(unsigned-byte 8).

(with-open-file (stream #P"/path/to/file" :element-type '(unsigned-byte 8))
  (let ((bit-stream (make-instance 'bit-input-stream
                                   :callback (lambda (buffer)
                                               (read-sequence buffer stream))
                                   :buffer-size 4096))) ;; buffer-size defaults to 4096.
    (read-byte s)
    (read-byte s)))

A convenience function `make-stream-input-callback' is also defined.

(with-open-file (stream #P"/path/to/file" :element-type '(unsigned-byte 8))
  (let ((bit-stream (make-instance 'bit-input-stream
                                   :callback (make-stream-input-callback stream))))
    (read-byte s)
    (read-byte s)))

Ex: Infinite bit-stream.

As the buffer if filled when all elements have been read this will result in an infinite stream of bits.

(let ((s (make-instance 'bit-input-stream
                        :callback (lambda (buffer)
                                    (dotimes (i (length buffer))
                                      (setf (aref buffer i) 254))
                                    (length buffer))
                        :buffer-size 4096)))
  (read-byte s) ;;-> 0
  (read-byte s)) ;;-> 1

Macros.

There is also wrapper macro `with-bit-input-stream'. It is also possible to write to a sequence. Any type will work.

(let ((octet-stream (make-some-octet-stream-with-elements-254)) ;; Imagined function.
      (bit-seq (make-array 16 :element-type 'bit)))
  (with-bit-input-stream (bit-stream :callback (make-stream-input-callback stream))
    (read-sequence bit-seq bit-stream)))

;; -> #*0111111101111111

Writing.

Writing bits is done in much the same way.

(let ((octet-stream (flexi-streams:make-in-memory-output-stream)))
  (with-bit-output-stream (s :callback (make-stream-output-callback octet-stream))
         (write-byte 0 s)
         (write-byte 1 s)
         (flush-bit-output-stream s)
         (flexi-streams:get-output-stream-sequence octet-stream)))

;;-> #(2)

The library implements trivial-gray-streams so the typical stream interface is implemented.

Installation

(ql:quickload :trivial-bit-streams)

Author

Copyright

Copyright (c) 2017 Dmitry Ignatiev (lovesan.ru@gmail.com)

License

Licensed under the MIT License.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 trivial-bit-streams

Maintainer

Dmitry Ignatiev <lovesan.ru@gmail.com>

Author

Dmitry Ignatiev <lovesan.ru@gmail.com>

License

MIT

Description

Trivial bit streams

Version

0.1.2

Dependency

trivial-gray-streams

Source

trivial-bit-streams.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 trivial-bit-streams/src

Parent

trivial-bit-streams (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 trivial-bit-streams.asd

Location

trivial-bit-streams.asd

Systems

trivial-bit-streams (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/package.lisp

Packages

trivial-bit-streams


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

package.lisp (file)

Parent

src (module)

Location

src/classes.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

classes.lisp (file)

Parent

src (module)

Location

src/methods.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 trivial-bit-streams

Source

package.lisp (file)

Nicknames
Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

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

Default buffer size for input bit stream, in octets.

Package

trivial-bit-streams

Source

classes.lisp (file)

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

Default buffer size for output bit stream, in octets.

Package

trivial-bit-streams

Source

classes.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: with-bit-input-stream (VAR &key CALLBACK BUFFER-SIZE) &body BODY
Package

trivial-bit-streams

Source

methods.lisp (file)

Macro: with-bit-output-stream (VAR &key CALLBACK BUFFER-SIZE) &body BODY
Package

trivial-bit-streams

Source

methods.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: bit-stream-byte-counter BIT-STREAM

Retrieves total number of bytes processed by bit stream

Package

trivial-bit-streams

Source

methods.lisp (file)

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 (file)

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 (file)

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

trivial-bit-streams

Source

methods.lisp (file)

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

trivial-bit-streams

Source

methods.lisp (file)

Function: make-stream-input-callback STREAM
Package

trivial-bit-streams

Source

methods.lisp (file)

Function: make-stream-output-callback STREAM
Package

trivial-bit-streams

Source

methods.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: write-bit BIT BIT-STREAM

Writes a single bit to the bit output stream.

Package

trivial-bit-streams

Source

methods.lisp (file)

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 (file)

Function: write-octet OCTET BIT-STREAM

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

Package

trivial-bit-streams

Source

methods.lisp (file)

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Generic functions

Generic Function: bit-stream-buffer-overflow-buffer-size CONDITION
Generic Function: (setf bit-stream-buffer-overflow-buffer-size) NEW-VALUE CONDITION
Package

trivial-bit-streams

Methods
Method: bit-stream-buffer-overflow-buffer-size (CONDITION bit-stream-buffer-overflow)
Method: (setf bit-stream-buffer-overflow-buffer-size) NEW-VALUE (CONDITION bit-stream-buffer-overflow)
Source

classes.lisp (file)

Generic Function: bit-stream-buffer-overflow-index CONDITION
Generic Function: (setf bit-stream-buffer-overflow-index) NEW-VALUE CONDITION
Package

trivial-bit-streams

Methods
Method: bit-stream-buffer-overflow-index (CONDITION bit-stream-buffer-overflow)
Method: (setf bit-stream-buffer-overflow-index) NEW-VALUE (CONDITION bit-stream-buffer-overflow)
Source

classes.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 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 (file)

Direct superclasses

bit-stream-error (condition)

Direct methods
Direct slots
Slot: index
Initargs

:index

Readers

bit-stream-buffer-overflow-index (generic function)

Writers

(setf bit-stream-buffer-overflow-index) (generic function)

Slot: buffer-size
Initargs

:buffer-size

Readers

bit-stream-buffer-overflow-buffer-size (generic function)

Writers

(setf bit-stream-buffer-overflow-buffer-size) (generic function)

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 (file)

Direct superclasses

bit-stream-error (condition)

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 (file)

Direct superclasses
Condition: bit-stream-error ()

Represents a bit stream i/o error

Package

trivial-bit-streams

Source

classes.lisp (file)

Direct superclasses

stream-error (condition)

Direct subclasses

Previous: , Up: Exported definitions   [Contents][Index]

6.1.6 Classes

Class: bit-input-stream ()

Represents the state of the bit input stream.

Package

trivial-bit-streams

Source

classes.lisp (file)

Direct superclasses
  • fundamental-binary-input-stream (class)
  • trivial-gray-stream-mixin (class)
  • bit-stream (class)
Direct methods
  • stream-read-sequence (method)
  • stream-read-byte (method)
  • stream-listen (method)
  • stream-clear-input (method)
  • shared-initialize (method)
Direct Default Initargs
InitargValue
:buffer-sizetrivial-bit-streams:*default-bit-output-stream-buffer-size*
:callback(lambda (&rest trivial-bit-streams::args) (declare (ignore trivial-bit-streams::args)) (values))
Class: bit-output-stream ()

Represents the state of the bit output stream.

Package

trivial-bit-streams

Source

classes.lisp (file)

Direct superclasses
  • fundamental-binary-output-stream (class)
  • trivial-gray-stream-mixin (class)
  • bit-stream (class)
Direct methods
  • stream-write-sequence (method)
  • stream-write-byte (method)
  • stream-clear-output (method)
  • stream-finish-output (method)
  • stream-force-output (method)
  • shared-initialize (method)
Direct Default Initargs
InitargValue
:buffer-sizetrivial-bit-streams:*default-bit-input-stream-buffer-size*
:callback(lambda (&rest trivial-bit-streams::args) (declare (ignore trivial-bit-streams::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 (file)

Direct superclasses

fundamental-binary-stream (class)

Direct subclasses
Direct methods
Direct slots
Slot: core
Type

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

Slot: callback
Type

function

Initargs

:callback

Readers

bit-stream-callback (generic function)

Writers

(setf bit-stream-callback) (generic function)

Slot: buffer-size
Type

trivial-bit-streams::positive-fixnum

Initargs

:buffer-size


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: bit-input-stream-core-buffer INSTANCE
Function: (setf bit-input-stream-core-buffer) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-input-stream-core-byte-counter INSTANCE
Function: (setf bit-input-stream-core-byte-counter) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-input-stream-core-end INSTANCE
Function: (setf bit-input-stream-core-end) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-input-stream-core-ibit INSTANCE
Function: (setf bit-input-stream-core-ibit) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-input-stream-core-ibyte INSTANCE
Function: (setf bit-input-stream-core-ibyte) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-input-stream-core-p OBJECT
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-output-stream-core-buffer INSTANCE
Function: (setf bit-output-stream-core-buffer) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-output-stream-core-byte-counter INSTANCE
Function: (setf bit-output-stream-core-byte-counter) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-output-stream-core-end INSTANCE
Function: (setf bit-output-stream-core-end) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-output-stream-core-ibit INSTANCE
Function: (setf bit-output-stream-core-ibit) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-output-stream-core-ibyte INSTANCE
Function: (setf bit-output-stream-core-ibyte) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-output-stream-core-p OBJECT
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-stream-core-buffer INSTANCE
Function: (setf bit-stream-core-buffer) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-stream-core-byte-counter INSTANCE
Function: (setf bit-stream-core-byte-counter) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-stream-core-end INSTANCE
Function: (setf bit-stream-core-end) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-stream-core-ibit INSTANCE
Function: (setf bit-stream-core-ibit) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-stream-core-ibyte INSTANCE
Function: (setf bit-stream-core-ibyte) VALUE INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: bit-stream-core-p OBJECT
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: copy-bit-input-stream-core INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: copy-bit-output-stream-core INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: copy-bit-stream-core INSTANCE
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: ensure-input BIT-STREAM-CORE BIT-STREAM
Package

trivial-bit-streams

Source

methods.lisp (file)

Function: ensure-output BIT-STREAM-CORE CALLBACK
Package

trivial-bit-streams

Source

methods.lisp (file)

Function: inc-bit-counter BIT-STREAM-CORE &optional N
Package

trivial-bit-streams

Source

methods.lisp (file)

Function: make-bit-input-stream-core BUFFER-SIZE &aux BUFFER
Package

trivial-bit-streams

Source

classes.lisp (file)

Function: make-bit-output-stream-core BUFFER-SIZE &aux BUFFER END
Package

trivial-bit-streams

Source

classes.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Generic functions

Generic Function: bit-stream-callback OBJECT
Generic Function: (setf bit-stream-callback) NEW-VALUE OBJECT
Package

trivial-bit-streams

Methods
Method: bit-stream-callback (BIT-STREAM bit-stream)

automatically generated reader method

Source

classes.lisp (file)

Method: (setf bit-stream-callback) NEW-VALUE (BIT-STREAM bit-stream)

automatically generated writer method

Source

classes.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Structures

Structure: bit-input-stream-core ()
Package

trivial-bit-streams

Source

classes.lisp (file)

Direct superclasses

bit-stream-core (structure)

Structure: bit-output-stream-core ()
Package

trivial-bit-streams

Source

classes.lisp (file)

Direct superclasses

bit-stream-core (structure)

Structure: bit-stream-core ()
Package

trivial-bit-streams

Source

classes.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses
Direct slots
Slot: buffer
Type

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

Readers

bit-stream-core-buffer (function)

Writers

(setf bit-stream-core-buffer) (function)

Slot: end
Type

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

Initform

0

Readers

bit-stream-core-end (function)

Writers

(setf bit-stream-core-end) (function)

Slot: ibyte
Type

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

Initform

0

Readers

bit-stream-core-ibyte (function)

Writers

(setf bit-stream-core-ibyte) (function)

Slot: ibit
Type

trivial-bit-streams::bit-counter

Initform

0

Readers

bit-stream-core-ibit (function)

Writers

(setf bit-stream-core-ibit) (function)

Slot: byte-counter
Type

unsigned-byte

Initform

0

Readers

bit-stream-core-byte-counter (function)

Writers

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


Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Types

Type: bit-counter ()
Package

trivial-bit-streams

Source

classes.lisp (file)

Type: non-negative-fixnum ()
Package

trivial-bit-streams

Source

classes.lisp (file)

Type: positive-fixnum ()
Package

trivial-bit-streams

Source

classes.lisp (file)

Type: simple-ub8-vector ()
Package

trivial-bit-streams

Source

classes.lisp (file)

Type: ub4 ()
Package

trivial-bit-streams

Source

classes.lisp (file)

Type: ub8 ()
Package

trivial-bit-streams

Source

classes.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   T  
Index Entry  Section

F
File, Lisp, trivial-bit-streams.asd: The trivial-bit-streams<dot>asd file
File, Lisp, trivial-bit-streams/src/classes.lisp: The trivial-bit-streams/src/classes<dot>lisp file
File, Lisp, trivial-bit-streams/src/methods.lisp: The trivial-bit-streams/src/methods<dot>lisp file
File, Lisp, trivial-bit-streams/src/package.lisp: The trivial-bit-streams/src/package<dot>lisp file

L
Lisp File, trivial-bit-streams.asd: The trivial-bit-streams<dot>asd file
Lisp File, trivial-bit-streams/src/classes.lisp: The trivial-bit-streams/src/classes<dot>lisp file
Lisp File, trivial-bit-streams/src/methods.lisp: The trivial-bit-streams/src/methods<dot>lisp file
Lisp File, trivial-bit-streams/src/package.lisp: The trivial-bit-streams/src/package<dot>lisp file

M
Module, trivial-bit-streams/src: The trivial-bit-streams/src module

T
trivial-bit-streams.asd: The trivial-bit-streams<dot>asd file
trivial-bit-streams/src: The trivial-bit-streams/src module
trivial-bit-streams/src/classes.lisp: The trivial-bit-streams/src/classes<dot>lisp file
trivial-bit-streams/src/methods.lisp: The trivial-bit-streams/src/methods<dot>lisp file
trivial-bit-streams/src/package.lisp: The trivial-bit-streams/src/package<dot>lisp file

Jump to:   F   L   M   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
B   C   E   F   G   I   M   R   W  
Index Entry  Section

(
(setf bit-input-stream-core-buffer): Internal functions
(setf bit-input-stream-core-byte-counter): Internal functions
(setf bit-input-stream-core-end): Internal functions
(setf bit-input-stream-core-ibit): Internal functions
(setf bit-input-stream-core-ibyte): Internal functions
(setf bit-output-stream-core-buffer): Internal functions
(setf bit-output-stream-core-byte-counter): Internal functions
(setf bit-output-stream-core-end): Internal functions
(setf bit-output-stream-core-ibit): Internal functions
(setf bit-output-stream-core-ibyte): Internal functions
(setf bit-stream-buffer-overflow-buffer-size): Exported generic functions
(setf bit-stream-buffer-overflow-buffer-size): Exported generic functions
(setf bit-stream-buffer-overflow-index): Exported generic functions
(setf bit-stream-buffer-overflow-index): Exported generic functions
(setf bit-stream-callback): Internal generic functions
(setf bit-stream-callback): Internal generic functions
(setf bit-stream-core-buffer): Internal functions
(setf bit-stream-core-byte-counter): Internal functions
(setf bit-stream-core-end): Internal functions
(setf bit-stream-core-ibit): Internal functions
(setf bit-stream-core-ibyte): Internal functions

B
bit-input-stream-core-buffer: Internal functions
bit-input-stream-core-byte-counter: Internal functions
bit-input-stream-core-end: Internal functions
bit-input-stream-core-ibit: Internal functions
bit-input-stream-core-ibyte: Internal functions
bit-input-stream-core-p: Internal functions
bit-output-stream-core-buffer: Internal functions
bit-output-stream-core-byte-counter: Internal functions
bit-output-stream-core-end: Internal functions
bit-output-stream-core-ibit: Internal functions
bit-output-stream-core-ibyte: Internal functions
bit-output-stream-core-p: Internal functions
bit-stream-buffer-overflow-buffer-size: Exported generic functions
bit-stream-buffer-overflow-buffer-size: Exported generic functions
bit-stream-buffer-overflow-index: Exported generic functions
bit-stream-buffer-overflow-index: Exported generic functions
bit-stream-byte-counter: Exported functions
bit-stream-callback: Internal generic functions
bit-stream-callback: Internal generic functions
bit-stream-core-buffer: Internal functions
bit-stream-core-byte-counter: Internal functions
bit-stream-core-end: Internal functions
bit-stream-core-ibit: Internal functions
bit-stream-core-ibyte: Internal functions
bit-stream-core-p: Internal functions

C
copy-bit-input-stream-core: Internal functions
copy-bit-output-stream-core: Internal functions
copy-bit-stream-core: Internal functions

E
ensure-input: Internal functions
ensure-output: Internal functions

F
flush-bit-input-stream: Exported functions
flush-bit-output-stream: Exported functions
Function, (setf bit-input-stream-core-buffer): Internal functions
Function, (setf bit-input-stream-core-byte-counter): Internal functions
Function, (setf bit-input-stream-core-end): Internal functions
Function, (setf bit-input-stream-core-ibit): Internal functions
Function, (setf bit-input-stream-core-ibyte): Internal functions
Function, (setf bit-output-stream-core-buffer): Internal functions
Function, (setf bit-output-stream-core-byte-counter): Internal functions
Function, (setf bit-output-stream-core-end): Internal functions
Function, (setf bit-output-stream-core-ibit): Internal functions
Function, (setf bit-output-stream-core-ibyte): Internal functions
Function, (setf bit-stream-core-buffer): Internal functions
Function, (setf bit-stream-core-byte-counter): Internal functions
Function, (setf bit-stream-core-end): Internal functions
Function, (setf bit-stream-core-ibit): Internal functions
Function, (setf bit-stream-core-ibyte): Internal functions
Function, bit-input-stream-core-buffer: Internal functions
Function, bit-input-stream-core-byte-counter: Internal functions
Function, bit-input-stream-core-end: Internal functions
Function, bit-input-stream-core-ibit: Internal functions
Function, bit-input-stream-core-ibyte: Internal functions
Function, bit-input-stream-core-p: Internal functions
Function, bit-output-stream-core-buffer: Internal functions
Function, bit-output-stream-core-byte-counter: Internal functions
Function, bit-output-stream-core-end: Internal functions
Function, bit-output-stream-core-ibit: Internal functions
Function, bit-output-stream-core-ibyte: Internal functions
Function, bit-output-stream-core-p: Internal functions
Function, bit-stream-byte-counter: Exported functions
Function, bit-stream-core-buffer: Internal functions
Function, bit-stream-core-byte-counter: Internal functions
Function, bit-stream-core-end: Internal functions
Function, bit-stream-core-ibit: Internal functions
Function, bit-stream-core-ibyte: Internal functions
Function, bit-stream-core-p: Internal functions
Function, copy-bit-input-stream-core: Internal functions
Function, copy-bit-output-stream-core: Internal functions
Function, copy-bit-stream-core: Internal functions
Function, ensure-input: Internal functions
Function, ensure-output: Internal functions
Function, flush-bit-input-stream: Exported functions
Function, flush-bit-output-stream: Exported functions
Function, inc-bit-counter: Internal functions
Function, make-bit-input-stream-core: Internal functions
Function, make-bit-output-stream-core: Internal functions
Function, make-blackhole-output-callback: Exported functions
Function, make-eof-input-callback: Exported functions
Function, make-stream-input-callback: Exported functions
Function, make-stream-output-callback: Exported functions
Function, read-bit: Exported functions
Function, read-bits: Exported functions
Function, read-octet: Exported functions
Function, read-octet-vector: Exported functions
Function, write-bit: Exported functions
Function, write-bits: Exported functions
Function, write-octet: Exported functions
Function, write-octet-vector: Exported functions

G
Generic Function, (setf bit-stream-buffer-overflow-buffer-size): Exported generic functions
Generic Function, (setf bit-stream-buffer-overflow-index): Exported generic functions
Generic Function, (setf bit-stream-callback): Internal generic functions
Generic Function, bit-stream-buffer-overflow-buffer-size: Exported generic functions
Generic Function, bit-stream-buffer-overflow-index: Exported generic functions
Generic Function, bit-stream-callback: Internal generic functions

I
inc-bit-counter: Internal functions

M
Macro, with-bit-input-stream: Exported macros
Macro, with-bit-output-stream: Exported macros
make-bit-input-stream-core: Internal functions
make-bit-output-stream-core: Internal functions
make-blackhole-output-callback: Exported functions
make-eof-input-callback: Exported functions
make-stream-input-callback: Exported functions
make-stream-output-callback: Exported functions
Method, (setf bit-stream-buffer-overflow-buffer-size): Exported generic functions
Method, (setf bit-stream-buffer-overflow-index): Exported generic functions
Method, (setf bit-stream-callback): Internal generic functions
Method, bit-stream-buffer-overflow-buffer-size: Exported generic functions
Method, bit-stream-buffer-overflow-index: Exported generic functions
Method, bit-stream-callback: Internal generic functions

R
read-bit: Exported functions
read-bits: Exported functions
read-octet: Exported functions
read-octet-vector: Exported functions

W
with-bit-input-stream: Exported macros
with-bit-output-stream: Exported macros
write-bit: Exported functions
write-bits: Exported functions
write-octet: Exported functions
write-octet-vector: Exported functions

Jump to:   (  
B   C   E   F   G   I   M   R   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
B   C   E   I   S  
Index Entry  Section

*
*bit-stream-bit-io*: Exported special variables
*default-bit-input-stream-buffer-size*: Exported special variables
*default-bit-output-stream-buffer-size*: Exported special variables

B
buffer: Internal structures
buffer-size: Exported conditions
buffer-size: Exported classes
byte-counter: Internal structures

C
callback: Exported classes
core: Exported classes

E
end: Internal structures

I
ibit: Internal structures
ibyte: Internal structures
index: Exported conditions

S
Slot, buffer: Internal structures
Slot, buffer-size: Exported conditions
Slot, buffer-size: Exported classes
Slot, byte-counter: Internal structures
Slot, callback: Exported classes
Slot, core: Exported classes
Slot, end: Internal structures
Slot, ibit: Internal structures
Slot, ibyte: Internal structures
Slot, index: Exported conditions
Special Variable, *bit-stream-bit-io*: Exported special variables
Special Variable, *default-bit-input-stream-buffer-size*: Exported special variables
Special Variable, *default-bit-output-stream-buffer-size*: Exported special variables

Jump to:   *  
B   C   E   I   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   N   P   S   T   U  
Index Entry  Section

B
bit-counter: Internal types
bit-input-stream: Exported classes
bit-input-stream-core: Internal structures
bit-output-stream: Exported classes
bit-output-stream-core: Internal structures
bit-stream: Exported classes
bit-stream-buffer-overflow: Exported conditions
bit-stream-closed-error: Exported conditions
bit-stream-core: Internal structures
bit-stream-end-of-file: Exported conditions
bit-stream-error: Exported conditions

C
Class, bit-input-stream: Exported classes
Class, bit-output-stream: Exported classes
Class, bit-stream: Exported classes
Condition, bit-stream-buffer-overflow: Exported conditions
Condition, bit-stream-closed-error: Exported conditions
Condition, bit-stream-end-of-file: Exported conditions
Condition, bit-stream-error: Exported conditions

N
non-negative-fixnum: Internal types

P
Package, trivial-bit-streams: The trivial-bit-streams package
positive-fixnum: Internal types

S
simple-ub8-vector: Internal types
Structure, bit-input-stream-core: Internal structures
Structure, bit-output-stream-core: Internal structures
Structure, bit-stream-core: Internal structures
System, trivial-bit-streams: The trivial-bit-streams system

T
trivial-bit-streams: The trivial-bit-streams system
trivial-bit-streams: The trivial-bit-streams package
Type, bit-counter: Internal types
Type, non-negative-fixnum: Internal types
Type, positive-fixnum: Internal types
Type, simple-ub8-vector: Internal types
Type, ub4: Internal types
Type, ub8: Internal types

U
ub4: Internal types
ub8: Internal types

Jump to:   B   C   N   P   S   T   U