The trivial-octet-streams Reference Manual

This is the trivial-octet-streams Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:33:43 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-octet-streams

A library for octet input and output streams analogous to string streams.

Maintainer

Nathan Froyd <>

Author

Nathan Froyd <>

Version

0.1

Source

trivial-octet-streams.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 trivial-octet-streams/trivial-octet-streams.asd

Source

trivial-octet-streams.asd.

Parent Component

trivial-octet-streams (system).

ASDF Systems

trivial-octet-streams.

Packages

trivial-octet-streams-system.


3.1.2 trivial-octet-streams/package.lisp

Source

trivial-octet-streams.asd.

Parent Component

trivial-octet-streams (system).

Packages

trivial-octet-streams.


3.1.3 trivial-octet-streams/octet-streams.lisp

Dependency

package.lisp (file).

Source

trivial-octet-streams.asd.

Parent Component

trivial-octet-streams (system).

Public Interface
Internals

3.2 Static


3.2.1 trivial-octet-streams/README

Source

trivial-octet-streams.asd.

Parent Component

trivial-octet-streams (system).


3.2.2 trivial-octet-streams/LICENSE

Source

trivial-octet-streams.asd.

Parent Component

trivial-octet-streams (system).


4 Packages

Packages are listed by definition order.


4.1 trivial-octet-streams-system

Source

trivial-octet-streams.asd.

Use List

common-lisp.


4.2 trivial-octet-streams

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: get-output-stream-octets (stream)

As GET-OUTPUT-STREAM-STRING, only with an octet output-stream instead of a string output-stream.

Package

trivial-octet-streams.

Source

octet-streams.lisp.

Function: make-octet-input-stream (buffer &optional start end)

As MAKE-STRING-INPUT-STREAM, only with octets instead of characters.

Package

trivial-octet-streams.

Source

octet-streams.lisp.

Function: make-octet-output-stream ()

As MAKE-STRING-OUTPUT-STREAM, only with octets instead of characters.

Package

trivial-octet-streams.

Source

octet-streams.lisp.


5.1.2 Standalone methods

Method: stream-clear-output ((stream octet-output-stream))
Package

sb-gray.

Source

octet-streams.lisp.

Method: stream-element-type ((stream octet-stream))
Source

octet-streams.lisp.

Method: stream-read-byte ((stream octet-input-stream))
Package

sb-gray.

Source

octet-streams.lisp.

Method: stream-read-sequence ((stream octet-input-stream) seq &optional start end)
Package

sb-gray.

Source

octet-streams.lisp.

Method: stream-write-byte ((stream octet-output-stream) integer)
Package

sb-gray.

Source

octet-streams.lisp.

Method: stream-write-sequence ((stream octet-output-stream) seq &optional start end)
Package

sb-gray.

Source

octet-streams.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *binary-input-stream-class*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *binary-output-stream-class*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *stream-clear-output-function*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *stream-element-type-function*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *stream-finish-output-function*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *stream-force-output-function*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *stream-read-byte-function*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *stream-read-sequence-function*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *stream-write-byte-function*
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Special Variable: *stream-write-sequence-function*
Package

trivial-octet-streams.

Source

octet-streams.lisp.


5.2.2 Macros

Macro: define-stream-read-sequence (specializer type &body body)
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Macro: define-stream-write-sequence (specializer type &body body)
Package

trivial-octet-streams.

Source

octet-streams.lisp.


5.2.3 Generic functions

Generic Reader: buffer (object)
Package

trivial-octet-streams.

Methods
Reader Method: buffer ((octet-stream octet-stream))

automatically generated reader method

Source

octet-streams.lisp.

Target Slot

buffer.

Generic Writer: (setf buffer) (object)
Package

trivial-octet-streams.

Methods
Writer Method: (setf buffer) ((octet-stream octet-stream))

automatically generated writer method

Source

octet-streams.lisp.

Target Slot

buffer.

Generic Reader: end (object)
Package

trivial-octet-streams.

Methods
Reader Method: end ((octet-input-stream octet-input-stream))

automatically generated reader method

Source

octet-streams.lisp.

Target Slot

end.

Generic Writer: (setf end) (object)
Package

trivial-octet-streams.

Methods
Writer Method: (setf end) ((octet-input-stream octet-input-stream))

automatically generated writer method

Source

octet-streams.lisp.

Target Slot

end.

Generic Reader: index (object)
Package

trivial-octet-streams.

Methods
Reader Method: index ((octet-output-stream octet-output-stream))

automatically generated reader method

Source

octet-streams.lisp.

Target Slot

index.

Reader Method: index ((octet-input-stream octet-input-stream))

automatically generated reader method

Source

octet-streams.lisp.

Target Slot

index.

Generic Writer: (setf index) (object)
Package

trivial-octet-streams.

Methods
Writer Method: (setf index) ((octet-output-stream octet-output-stream))

automatically generated writer method

Source

octet-streams.lisp.

Target Slot

index.

Writer Method: (setf index) ((octet-input-stream octet-input-stream))

automatically generated writer method

Source

octet-streams.lisp.

Target Slot

index.


5.2.4 Classes

Class: octet-input-stream
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: index
Type

trivial-octet-streams::index

Initargs

:index

Readers

index.

Writers

(setf index).

Slot: end
Type

trivial-octet-streams::index

Initargs

:end

Readers

end.

Writers

(setf end).

Class: octet-output-stream
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: index
Type

trivial-octet-streams::index

Initform

0

Readers

index.

Writers

(setf index).

Class: octet-stream
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: buffer
Type

trivial-octet-streams::simple-octet-vector

Initargs

:buffer

Readers

buffer.

Writers

(setf buffer).


5.2.5 Types

Type: index ()
Package

trivial-octet-streams.

Source

octet-streams.lisp.

Type: simple-octet-vector (&optional length)
Package

trivial-octet-streams.

Source

octet-streams.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   D   E   F   G   I   M   S  
Index Entry  Section

(
(setf buffer): Private generic functions
(setf buffer): Private generic functions
(setf end): Private generic functions
(setf end): Private generic functions
(setf index): Private generic functions
(setf index): Private generic functions
(setf index): Private generic functions

B
buffer: Private generic functions
buffer: Private generic functions

D
define-stream-read-sequence: Private macros
define-stream-write-sequence: Private macros

E
end: Private generic functions
end: Private generic functions

F
Function, get-output-stream-octets: Public ordinary functions
Function, make-octet-input-stream: Public ordinary functions
Function, make-octet-output-stream: Public ordinary functions

G
Generic Function, (setf buffer): Private generic functions
Generic Function, (setf end): Private generic functions
Generic Function, (setf index): Private generic functions
Generic Function, buffer: Private generic functions
Generic Function, end: Private generic functions
Generic Function, index: Private generic functions
get-output-stream-octets: Public ordinary functions

I
index: Private generic functions
index: Private generic functions
index: Private generic functions

M
Macro, define-stream-read-sequence: Private macros
Macro, define-stream-write-sequence: Private macros
make-octet-input-stream: Public ordinary functions
make-octet-output-stream: Public ordinary functions
Method, (setf buffer): Private generic functions
Method, (setf end): Private generic functions
Method, (setf index): Private generic functions
Method, (setf index): Private generic functions
Method, buffer: Private generic functions
Method, end: Private generic functions
Method, index: Private generic functions
Method, index: Private generic functions
Method, stream-clear-output: Public standalone methods
Method, stream-element-type: Public standalone methods
Method, stream-read-byte: Public standalone methods
Method, stream-read-sequence: Public standalone methods
Method, stream-write-byte: Public standalone methods
Method, stream-write-sequence: Public standalone methods

S
stream-clear-output: Public standalone methods
stream-element-type: Public standalone methods
stream-read-byte: Public standalone methods
stream-read-sequence: Public standalone methods
stream-write-byte: Public standalone methods
stream-write-sequence: Public standalone methods


A.3 Variables

Jump to:   *  
B   E   I   S  
Index Entry  Section

*
*binary-input-stream-class*: Private special variables
*binary-output-stream-class*: Private special variables
*stream-clear-output-function*: Private special variables
*stream-element-type-function*: Private special variables
*stream-finish-output-function*: Private special variables
*stream-force-output-function*: Private special variables
*stream-read-byte-function*: Private special variables
*stream-read-sequence-function*: Private special variables
*stream-write-byte-function*: Private special variables
*stream-write-sequence-function*: Private special variables

B
buffer: Private classes

E
end: Private classes

I
index: Private classes
index: Private classes

S
Slot, buffer: Private classes
Slot, end: Private classes
Slot, index: Private classes
Slot, index: Private classes
Special Variable, *binary-input-stream-class*: Private special variables
Special Variable, *binary-output-stream-class*: Private special variables
Special Variable, *stream-clear-output-function*: Private special variables
Special Variable, *stream-element-type-function*: Private special variables
Special Variable, *stream-finish-output-function*: Private special variables
Special Variable, *stream-force-output-function*: Private special variables
Special Variable, *stream-read-byte-function*: Private special variables
Special Variable, *stream-read-sequence-function*: Private special variables
Special Variable, *stream-write-byte-function*: Private special variables
Special Variable, *stream-write-sequence-function*: Private special variables


A.4 Data types

Jump to:   C   F   I   L   O   P   R   S   T  
Index Entry  Section

C
Class, octet-input-stream: Private classes
Class, octet-output-stream: Private classes
Class, octet-stream: Private classes

F
File, license: The trivial-octet-streams/license file
File, octet-streams.lisp: The trivial-octet-streams/octet-streams․lisp file
File, package.lisp: The trivial-octet-streams/package․lisp file
File, readme: The trivial-octet-streams/readme file
File, trivial-octet-streams.asd: The trivial-octet-streams/trivial-octet-streams․asd file

I
index: Private types

L
license: The trivial-octet-streams/license file

O
octet-input-stream: Private classes
octet-output-stream: Private classes
octet-stream: Private classes
octet-streams.lisp: The trivial-octet-streams/octet-streams․lisp file

P
Package, trivial-octet-streams: The trivial-octet-streams package
Package, trivial-octet-streams-system: The trivial-octet-streams-system package
package.lisp: The trivial-octet-streams/package․lisp file

R
readme: The trivial-octet-streams/readme file

S
simple-octet-vector: Private types
System, trivial-octet-streams: The trivial-octet-streams system

T
trivial-octet-streams: The trivial-octet-streams system
trivial-octet-streams: The trivial-octet-streams package
trivial-octet-streams-system: The trivial-octet-streams-system package
trivial-octet-streams.asd: The trivial-octet-streams/trivial-octet-streams․asd file
Type, index: Private types
Type, simple-octet-vector: Private types