The trivial-octet-streams Reference Manual

Table of Contents

The trivial-octet-streams Reference Manual

This is the trivial-octet-streams Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:30:05 2020 GMT+0.

1 Introduction

TRIVIAL-OCTET-STREAMS is a library to provide analogues to
MAKE-STRING-{INPUT,OUTPUT}-STREAM.  I find myself frequently wanting
such functionality, but it's not worth importing libraries like ironclad
or flexi-streams to get access to them.

2 Systems

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

2.1 trivial-octet-streams

Maintainer

Nathan Froyd <froydnj@gmail.com>

Author

Nathan Froyd <froydnj@gmail.com>

Description

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

Version

0.1

Source

trivial-octet-streams.asd (file)

Components

• readme (file)
• license (file)
• package.lisp (file)
• octet-streams.lisp (file)

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.asd

Location

trivial-octet-streams.asd

Systems

trivial-octet-streams (system)

Packages

trivial-octet-streams-system

3.1.2 trivial-octet-streams/package.lisp

Parent

trivial-octet-streams (system)

Location

package.lisp

Packages

trivial-octet-streams

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

Dependency

package.lisp (file)

Parent

trivial-octet-streams (system)

Location

octet-streams.lisp

Exported Definitions

• get-output-stream-octets (function)
• make-octet-input-stream (function)
• make-octet-output-stream (function)

Internal Definitions

• *binary-input-stream-class* (special variable)
• *binary-output-stream-class* (special variable)
• *stream-clear-output-function* (special variable)
• *stream-element-type-function* (special variable)
• *stream-finish-output-function* (special variable)
• *stream-force-output-function* (special variable)
• *stream-read-byte-function* (special variable)
• *stream-read-sequence-function* (special variable)
• *stream-write-byte-function* (special variable)
• *stream-write-sequence-function* (special variable)
• buffer (method)
• (setf buffer) (method)
• define-stream-read-sequence (macro)
• define-stream-write-sequence (macro)
• end (method)
• (setf end) (method)
• index (method)
• (setf index) (method)
• index (method)
• (setf index) (method)
• index (type)
• octet-input-stream (class)
• octet-output-stream (class)
• octet-stream (class)
• simple-octet-vector (type)

3.2 Static

3.2.1 trivial-octet-streams/README

Parent

trivial-octet-streams (system)

Location

README

3.2.2 trivial-octet-streams/LICENSE

Parent

trivial-octet-streams (system)

Location

LICENSE

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

Use List

common-lisp

Exported Definitions

• get-output-stream-octets (function)
• make-octet-input-stream (function)
• make-octet-output-stream (function)

Internal Definitions

• *binary-input-stream-class* (special variable)
• *binary-output-stream-class* (special variable)
• *stream-clear-output-function* (special variable)
• *stream-element-type-function* (special variable)
• *stream-finish-output-function* (special variable)
• *stream-force-output-function* (special variable)
• *stream-read-byte-function* (special variable)
• *stream-read-sequence-function* (special variable)
• *stream-write-byte-function* (special variable)
• *stream-write-sequence-function* (special variable)
• buffer (generic function)
• buffer (method)
• (setf buffer) (method)
• (setf buffer) (generic function)
• define-stream-read-sequence (macro)
• define-stream-write-sequence (macro)
• end (generic function)
• end (method)
• (setf end) (method)
• (setf end) (generic function)
• index (generic function)
• index (method)
• (setf index) (method)
• index (method)
• (setf index) (method)
• (setf index) (generic function)
• index (type)
• octet-input-stream (class)
• octet-output-stream (class)
• octet-stream (class)
• simple-octet-vector (type)

5 Definitions

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

5.1 Exported definitions

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

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

Function: make-octet-output-stream ()

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

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

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

5.2.2 Macros

Macro: define-stream-read-sequence SPECIALIZER TYPE &body BODY

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

Macro: define-stream-write-sequence SPECIALIZER TYPE &body BODY

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

5.2.3 Generic functions

Generic Function: buffer OBJECT

Generic Function: (setf buffer) NEW-VALUE OBJECT

Package

trivial-octet-streams

Methods

Method: buffer (OCTET-STREAM octet-stream)

automatically generated reader method

Source

octet-streams.lisp (file)

Method: (setf buffer) NEW-VALUE (OCTET-STREAM octet-stream)

automatically generated writer method

Source

octet-streams.lisp (file)

Generic Function: end OBJECT

Generic Function: (setf end) NEW-VALUE OBJECT

Package

trivial-octet-streams

Methods

Method: end (OCTET-INPUT-STREAM octet-input-stream)

automatically generated reader method

Source

octet-streams.lisp (file)

Method: (setf end) NEW-VALUE (OCTET-INPUT-STREAM octet-input-stream)

automatically generated writer method

Source

octet-streams.lisp (file)

Generic Function: index OBJECT

Generic Function: (setf index) NEW-VALUE OBJECT

Package

trivial-octet-streams

Methods

Method: index (OCTET-OUTPUT-STREAM octet-output-stream)

automatically generated reader method

Source

octet-streams.lisp (file)

Method: (setf index) NEW-VALUE (OCTET-OUTPUT-STREAM octet-output-stream)

automatically generated writer method

Source

octet-streams.lisp (file)

Method: index (OCTET-INPUT-STREAM octet-input-stream)

automatically generated reader method

Source

octet-streams.lisp (file)

Method: (setf index) NEW-VALUE (OCTET-INPUT-STREAM octet-input-stream)

automatically generated writer method

Source

octet-streams.lisp (file)

5.2.4 Classes

Class: octet-input-stream ()

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

Direct superclasses

• fundamental-binary-input-stream (class)
• octet-stream (class)

Direct methods

• stream-read-sequence (method)
• stream-read-byte (method)
• end (method)
• end (method)
• index (method)
• index (method)

Direct slots

Slot: index

Type

trivial-octet-streams::index

Initargs

:index

Readers

index (generic function)

Writers

(setf index) (generic function)

Slot: end

Type

trivial-octet-streams::index

Initargs

:end

Readers

end (generic function)

Writers

(setf end) (generic function)

Class: octet-output-stream ()

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

Direct superclasses

• fundamental-binary-output-stream (class)
• octet-stream (class)

Direct methods

• stream-clear-output (method)
• stream-write-sequence (method)
• stream-write-byte (method)
• index (method)
• index (method)

Direct slots

Slot: index

Type

trivial-octet-streams::index

Initform

0

Readers

index (generic function)

Writers

(setf index) (generic function)

Class: octet-stream ()

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• octet-input-stream (class)
• octet-output-stream (class)

Direct methods

• stream-element-type (method)
• buffer (method)
• buffer (method)

Direct slots

Slot: buffer

Type

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

Initargs

:buffer

Readers

buffer (generic function)

Writers

(setf buffer) (generic function)

5.2.5 Types

Type: index ()

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

Type: simple-octet-vector &optional LENGTH

Package

trivial-octet-streams

Source

octet-streams.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types