The trivial-octet-streams Reference Manual

Table of Contents

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

The trivial-octet-streams Reference Manual

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


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

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.


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

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

3 Files

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


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

3.1 Lisp


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

3.1.1 trivial-octet-streams.asd

Location

trivial-octet-streams.asd

Systems

trivial-octet-streams (system)

Packages

trivial-octet-streams-system


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

3.1.2 trivial-octet-streams/package.lisp

Parent

trivial-octet-streams (system)

Location

package.lisp

Packages

trivial-octet-streams


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

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

Dependency

package.lisp (file)

Parent

trivial-octet-streams (system)

Location

octet-streams.lisp

Exported Definitions
Internal Definitions

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

3.2 Other


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

3.2.1 trivial-octet-streams/README

Parent

trivial-octet-streams (system)

Location

README


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

3.2.2 trivial-octet-streams/LICENSE

Parent

trivial-octet-streams (system)

Location

LICENSE


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

4 Packages

Packages are listed by definition order.


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

4.1 trivial-octet-streams-system

Source

trivial-octet-streams.asd

Use List

common-lisp


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

4.2 trivial-octet-streams

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

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)


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

5.2 Internal definitions


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

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)


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

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)


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

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)


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

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


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

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   O   T  
Index Entry  Section

F
File, Lisp, trivial-octet-streams.asd: The trivial-octet-streams<dot>asd file
File, Lisp, trivial-octet-streams/octet-streams.lisp: The trivial-octet-streams/octet-streams<dot>lisp file
File, Lisp, trivial-octet-streams/package.lisp: The trivial-octet-streams/package<dot>lisp file
File, other, trivial-octet-streams/LICENSE: The trivial-octet-streams/license file
File, other, trivial-octet-streams/README: The trivial-octet-streams/readme file

L
Lisp File, trivial-octet-streams.asd: The trivial-octet-streams<dot>asd file
Lisp File, trivial-octet-streams/octet-streams.lisp: The trivial-octet-streams/octet-streams<dot>lisp file
Lisp File, trivial-octet-streams/package.lisp: The trivial-octet-streams/package<dot>lisp file

O
Other File, trivial-octet-streams/LICENSE: The trivial-octet-streams/license file
Other File, trivial-octet-streams/README: The trivial-octet-streams/readme file

T
trivial-octet-streams.asd: The trivial-octet-streams<dot>asd file
trivial-octet-streams/LICENSE: The trivial-octet-streams/license file
trivial-octet-streams/octet-streams.lisp: The trivial-octet-streams/octet-streams<dot>lisp file
trivial-octet-streams/package.lisp: The trivial-octet-streams/package<dot>lisp file
trivial-octet-streams/README: The trivial-octet-streams/readme file

Jump to:   F   L   O   T  

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

A.2 Functions

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

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

B
buffer: Internal generic functions
buffer: Internal generic functions

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

E
end: Internal generic functions
end: Internal generic functions

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

G
Generic Function, (setf buffer): Internal generic functions
Generic Function, (setf end): Internal generic functions
Generic Function, (setf index): Internal generic functions
Generic Function, buffer: Internal generic functions
Generic Function, end: Internal generic functions
Generic Function, index: Internal generic functions
get-output-stream-octets: Exported functions

I
index: Internal generic functions
index: Internal generic functions
index: Internal generic functions

M
Macro, define-stream-read-sequence: Internal macros
Macro, define-stream-write-sequence: Internal macros
make-octet-input-stream: Exported functions
make-octet-output-stream: Exported functions
Method, (setf buffer): Internal generic functions
Method, (setf end): Internal generic functions
Method, (setf index): Internal generic functions
Method, (setf index): Internal generic functions
Method, buffer: Internal generic functions
Method, end: Internal generic functions
Method, index: Internal generic functions
Method, index: Internal generic functions

Jump to:   (  
B   D   E   F   G   I   M  

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

A.3 Variables

Jump to:   *  
B   E   I   S  
Index Entry  Section

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

B
buffer: Internal classes

E
end: Internal classes

I
index: Internal classes
index: Internal classes

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

Jump to:   *  
B   E   I   S  

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

A.4 Data types

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

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

I
index: Internal types

O
octet-input-stream: Internal classes
octet-output-stream: Internal classes
octet-stream: Internal classes

P
Package, trivial-octet-streams: The trivial-octet-streams package
Package, trivial-octet-streams-system: The trivial-octet-streams-system package

S
simple-octet-vector: Internal 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
Type, index: Internal types
Type, simple-octet-vector: Internal types

Jump to:   C   I   O   P   S   T