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

The fast-io Reference Manual

This is the fast-io Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:05:12 2024 GMT+0.

Next: Systems, Previous: The fast-io Reference Manual, Up: The fast-io Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The fast-io Reference Manual [Contents][Index]

2 Systems

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

fast-io

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

2.1 `fast-io`

Alternative I/O mechanism to a stream or vector

Author

Ryan Pavlik

License

MIT

Version

1.0

Dependencies

alexandria (system).
trivial-gray-streams (system).
static-vectors (system).

Source

fast-io.asd.

Child Components

package.lisp (file).
types.lisp (file).
io.lisp (file).
gray.lisp (file).

Next: Packages, Previous: Systems, Up: The fast-io Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: fast-io/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `fast-io/fast-io.asd`

Source: fast-io.asd.
Parent Component: fast-io (system).
ASDF Systems: fast-io.

Next: fast-io/types.lisp, Previous: fast-io/fast-io.asd, Up: Lisp [Contents][Index]

3.1.2 `fast-io/package.lisp`

Source: fast-io.asd.
Parent Component: fast-io (system).
Packages: fast-io.

Next: fast-io/io.lisp, Previous: fast-io/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `fast-io/types.lisp`

Dependency

package.lisp (file).

Source

fast-io.asd.

Parent Component

fast-io (system).

Public Interface

index (type).
octet (type).
octet-vector (type).

Next: fast-io/gray.lisp, Previous: fast-io/types.lisp, Up: Lisp [Contents][Index]

3.1.4 `fast-io/io.lisp`

Dependency

types.lisp (file).

Source

fast-io.asd.

Parent Component

fast-io (system).

Public Interface

*default-output-buffer-size* (special variable).
buffer-position (function).
(setf buffer-position) (function).
fast-read-byte (function).
fast-read-sequence (function).
fast-write-byte (function).
fast-write-sequence (function).
finish-output-buffer (function).
input-buffer (structure).
input-buffer-stream (reader).
(setf input-buffer-stream) (writer).
input-buffer-vector (reader).
(setf input-buffer-vector) (writer).
make-input-buffer (function).
make-octet-vector (function).
make-output-buffer (function).
octets-from (function).
output-buffer (structure).
read128-be (function).
read128-le (function).
read16-be (function).
read16-le (function).
read32-be (function).
read32-le (function).
read64-be (function).
read64-le (function).
read8 (function).
readu128-be (function).
readu128-le (function).
readu16-be (function).
readu16-le (function).
readu32-be (function).
readu32-le (function).
readu64-be (function).
readu64-le (function).
readu8 (function).
with-fast-input (macro).
with-fast-output (macro).
write128-be (function).
write128-le (function).
write16-be (function).
write16-le (function).
write24-be (function).
write24-le (function).
write32-be (function).
write32-le (function).
write64-be (function).
write64-le (function).
write8 (function).
writeu128-be (function).
writeu128-le (function).
writeu16-be (function).
writeu16-le (function).
writeu24-be (function).
writeu24-le (function).
writeu32-be (function).
writeu32-le (function).
writeu64-be (function).
writeu64-le (function).
writeu8 (function).

Internals

concat-buffer (function).
copy-input-buffer (function).
copy-output-buffer (function).
extend (function).
fast-peek-byte (function).
flush (function).
input-buffer-p (function).
input-buffer-pos (reader).
(setf input-buffer-pos) (writer).
make-readers (macro).
make-writers (macro).
output-buffer-fill (reader).
(setf output-buffer-fill) (writer).
output-buffer-last (reader).
(setf output-buffer-last) (writer).
output-buffer-len (reader).
(setf output-buffer-len) (writer).
output-buffer-output (reader).
(setf output-buffer-output) (writer).
output-buffer-p (function).
output-buffer-queue (reader).
(setf output-buffer-queue) (writer).
output-buffer-vector (reader).
(setf output-buffer-vector) (writer).
read-unsigned-be (macro).
read-unsigned-le (macro).
read24-be (function).
read24-le (function).
readu24-be (function).
readu24-le (function).
signed-to-unsigned (function).
unsigned-to-signed (function).
write-unsigned-be (macro).
write-unsigned-le (macro).

Previous: fast-io/io.lisp, Up: Lisp [Contents][Index]

3.1.5 `fast-io/gray.lisp`

Dependency

io.lisp (file).

Source

fast-io.asd.

Parent Component

fast-io (system).

Public Interface

close (method).
close (method).
fast-input-stream (class).
fast-output-stream (class).
finish-output-stream (function).
initialize-instance (method).
initialize-instance (method).
input-stream-p (method).
open-stream-p (method).
output-stream-p (method).
stream-element-type (method).
stream-element-type (method).
(setf stream-file-position) (method).
stream-file-position (method).
stream-read-byte (method).
stream-read-sequence (method).
stream-write-byte (method).
stream-write-sequence (method).

Internals

fast-io-stream (class).
peek-byte (method).

Next: Definitions, Previous: Files, Up: The fast-io Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

fast-io

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

4.1 `fast-io`

Source

package.lisp.

Use List

alexandria.
common-lisp.
trivial-gray-streams.

Public Interface

*default-output-buffer-size* (special variable).
buffer-position (function).
(setf buffer-position) (function).
fast-input-stream (class).
fast-output-stream (class).
fast-read-byte (function).
fast-read-sequence (function).
fast-write-byte (function).
fast-write-sequence (function).
finish-output-buffer (function).
finish-output-stream (function).
index (type).
input-buffer (structure).
input-buffer-stream (reader).
(setf input-buffer-stream) (writer).
input-buffer-vector (reader).
(setf input-buffer-vector) (writer).
make-input-buffer (function).
make-octet-vector (function).
make-output-buffer (function).
octet (type).
octet-vector (type).
octets-from (function).
output-buffer (structure).
read128-be (function).
read128-le (function).
read16-be (function).
read16-le (function).
read32-be (function).
read32-le (function).
read64-be (function).
read64-le (function).
read8 (function).
read8-be (function).
read8-le (function).
readu128-be (function).
readu128-le (function).
readu16-be (function).
readu16-le (function).
readu32-be (function).
readu32-le (function).
readu64-be (function).
readu64-le (function).
readu8 (function).
readu8-be (function).
readu8-le (function).
with-fast-input (macro).
with-fast-output (macro).
write128-be (function).
write128-le (function).
write16-be (function).
write16-le (function).
write24-be (function).
write24-le (function).
write32-be (function).
write32-le (function).
write64-be (function).
write64-le (function).
write8 (function).
write8-be (function).
write8-le (function).
writeu128-be (function).
writeu128-le (function).
writeu16-be (function).
writeu16-le (function).
writeu24-be (function).
writeu24-le (function).
writeu32-be (function).
writeu32-le (function).
writeu64-be (function).
writeu64-le (function).
writeu8 (function).
writeu8-be (function).
writeu8-le (function).

Internals

concat-buffer (function).
copy-input-buffer (function).
copy-output-buffer (function).
extend (function).
fast-io-stream (class).
fast-peek-byte (function).
flush (function).
input-buffer-p (function).
input-buffer-pos (reader).
(setf input-buffer-pos) (writer).
make-readers (macro).
make-writers (macro).
output-buffer-fill (reader).
(setf output-buffer-fill) (writer).
output-buffer-last (reader).
(setf output-buffer-last) (writer).
output-buffer-len (reader).
(setf output-buffer-len) (writer).
output-buffer-output (reader).
(setf output-buffer-output) (writer).
output-buffer-p (function).
output-buffer-queue (reader).
(setf output-buffer-queue) (writer).
output-buffer-vector (reader).
(setf output-buffer-vector) (writer).
peek-byte (generic function).
read-unsigned-be (macro).
read-unsigned-le (macro).
read24-be (function).
read24-le (function).
readu24-be (function).
readu24-le (function).
signed-to-unsigned (function).
unsigned-to-signed (function).
write-unsigned-be (macro).
write-unsigned-le (macro).

Next: Indexes, Previous: Packages, Up: The fast-io Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Special variables
Macros
Ordinary functions
Standalone methods
Structures
Classes
Types

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Special variables

Special Variable: *default-output-buffer-size* ¶

Package: fast-io.
Source: io.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

5.1.2 Macros

Macro: with-fast-input ((buffer vector &optional stream offset) &body body) ¶

Package: fast-io.
Source: io.lisp.

Macro: with-fast-output ((buffer &optional output) &body body) ¶

Create ‘BUFFER‘, optionally outputting to ‘OUTPUT‘.

Package: fast-io.
Source: io.lisp.

Next: Standalone methods, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.3 Ordinary functions

Function: buffer-position (buffer) ¶

Return the number of bytes read (for an INPUT-BUFFER) or written (for an OUTPUT-BUFFER)

Package: fast-io.
Source: io.lisp.

Function: (setf buffer-position) (buffer) ¶

Set the buffer position for input-buffer

Package: fast-io.
Source: io.lisp.

Function: fast-read-byte (input-buffer &optional eof-error-p eof-value) ¶

Package: fast-io.
Source: io.lisp.

Function: fast-read-sequence (sequence input-buffer &optional start end) ¶

Package: fast-io.
Source: io.lisp.

Function: fast-write-byte (byte output-buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: fast-write-sequence (sequence output-buffer &optional start end) ¶

Package: fast-io.
Source: io.lisp.

Function: finish-output-buffer (output-buffer) ¶

Finish an output buffer. If it is backed by a vector (static or otherwise) it returns the final octet vector. If it is backed by a stream it ensures that all data has been flushed to the stream.

Package: fast-io.
Source: io.lisp.

Function: finish-output-stream (stream) ¶

Package: fast-io.
Source: gray.lisp.

Reader: input-buffer-stream (instance) ¶

Writer: (setf input-buffer-stream) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: stream.

Reader: input-buffer-vector (instance) ¶

Writer: (setf input-buffer-vector) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: vector.

Function: make-input-buffer (&key vector pos stream) ¶

Package: fast-io.
Source: io.lisp.

Function: make-octet-vector (len) ¶

Package: fast-io.
Source: io.lisp.

Function: make-output-buffer (&key vector fill len queue last output) ¶

Package: fast-io.
Source: io.lisp.

Function: octets-from (sequence) ¶

Package: fast-io.
Source: io.lisp.

Function: read128-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read128-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read16-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read16-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read32-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read32-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read64-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read64-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read8 (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read8-be (buffer) ¶

Package: fast-io.
Alias for: read8.

Function: read8-le (buffer) ¶

Package: fast-io.
Alias for: read8.

Function: readu128-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu128-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu16-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu16-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu32-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu32-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu64-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu64-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu8 (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu8-be (buffer) ¶

Package: fast-io.
Alias for: readu8.

Function: readu8-le (buffer) ¶

Package: fast-io.
Alias for: readu8.

Function: write128-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write128-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write16-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write16-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write24-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write24-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write32-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write32-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write64-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write64-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write8 (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: write8-be (value buffer) ¶

Package: fast-io.
Alias for: write8.

Function: write8-le (value buffer) ¶

Package: fast-io.
Alias for: write8.

Function: writeu128-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu128-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu16-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu16-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu24-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu24-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu32-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu32-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu64-be (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu64-le (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu8 (value buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: writeu8-be (value buffer) ¶

Package: fast-io.
Alias for: writeu8.

Function: writeu8-le (value buffer) ¶

Package: fast-io.
Alias for: writeu8.

Next: Structures, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.4 Standalone methods

Method: close ((stream fast-input-stream) &key abort) ¶

Source: gray.lisp.

Method: close ((stream fast-output-stream) &key abort) ¶

Source: gray.lisp.

Method: initialize-instance ((self fast-input-stream) &key stream vector &allow-other-keys) ¶

Source: gray.lisp.

Method: initialize-instance ((self fast-output-stream) &key stream buffer-size &allow-other-keys) ¶

Source: gray.lisp.

Method: input-stream-p ((stream fast-input-stream)) ¶

Source: gray.lisp.

Method: open-stream-p ((stream fast-io-stream)) ¶

Source: gray.lisp.

Method: output-stream-p ((stream fast-output-stream)) ¶

Source: gray.lisp.

Method: stream-element-type ((stream fast-input-stream)) ¶

Return element-type of the underlying vector or stream. Return NIL if none are present.

Source: gray.lisp.

Method: stream-element-type ((stream fast-output-stream)) ¶

Return the underlying array element-type. Should always return ’(unsigned-byte 8).

Source: gray.lisp.

Method: (setf stream-file-position) ((stream fast-input-stream)) ¶

Package: trivial-gray-streams.
Source: gray.lisp.

Method: stream-file-position ((stream fast-io-stream)) ¶

Package: trivial-gray-streams.
Source: gray.lisp.

Method: stream-read-byte ((stream fast-input-stream)) ¶

Package: sb-gray.
Source: gray.lisp.

Method: stream-read-sequence ((stream fast-input-stream) sequence start end &key &allow-other-keys) ¶

Package: trivial-gray-streams.
Source: gray.lisp.

Method: stream-write-byte ((stream fast-output-stream) byte) ¶

Package: sb-gray.
Source: gray.lisp.

Method: stream-write-sequence ((stream fast-output-stream) sequence start end &key &allow-other-keys) ¶

Package: trivial-gray-streams.
Source: gray.lisp.

Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.5 Structures

Structure: input-buffer ¶

Package

fast-io.

Source

io.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: vector ¶

Package: common-lisp.
Type: (or null fast-io:octet-vector)
Readers: input-buffer-vector.
Writers: (setf input-buffer-vector).

Slot: pos ¶

Type: fast-io:index
Initform: 0
Readers: input-buffer-pos.
Writers: (setf input-buffer-pos).

Slot: stream ¶

Package: common-lisp.
Readers: input-buffer-stream.
Writers: (setf input-buffer-stream).

Structure: output-buffer ¶

Package

fast-io.

Source

io.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: vector ¶

Package: common-lisp.
Type: fast-io:octet-vector
Initform: (fast-io:make-octet-vector fast-io:*default-output-buffer-size*)
Readers: output-buffer-vector.
Writers: (setf output-buffer-vector).

Slot: fill ¶

Package: common-lisp.
Type: fast-io:index
Initform: 0
Readers: output-buffer-fill.
Writers: (setf output-buffer-fill).

Slot: len ¶

Type: fast-io:index
Initform: 0
Readers: output-buffer-len.
Writers: (setf output-buffer-len).

Slot: queue ¶

Type: list
Readers: output-buffer-queue.
Writers: (setf output-buffer-queue).

Slot: last ¶

Package: common-lisp.
Type: list
Readers: output-buffer-last.
Writers: (setf output-buffer-last).

Slot: output ¶

Readers: output-buffer-output.
Writers: (setf output-buffer-output).

Next: Types, Previous: Structures, Up: Public Interface [Contents][Index]

5.1.6 Classes

Class: fast-input-stream ¶

Package

fast-io.

Source

gray.lisp.

Direct superclasses

fast-io-stream.
fundamental-input-stream.

Direct methods

close.
initialize-instance.
input-stream-p.
peek-byte.
stream-element-type.
(setf stream-file-position).
stream-read-byte.
stream-read-sequence.

Direct slots

Slot: buffer ¶

Type: fast-io:input-buffer

Class: fast-output-stream ¶

Package

fast-io.

Source

gray.lisp.

Direct superclasses

fast-io-stream.
fundamental-output-stream.

Direct methods

close.
initialize-instance.
output-stream-p.
stream-element-type.
stream-write-byte.
stream-write-sequence.

Direct slots

Slot: buffer ¶

Type: fast-io:output-buffer

Previous: Classes, Up: Public Interface [Contents][Index]

5.1.7 Types

Type: index () ¶

Package: fast-io.
Source: types.lisp.

Type: octet () ¶

Package: fast-io.
Source: types.lisp.

Type: octet-vector () ¶

Package: fast-io.
Source: types.lisp.

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

5.2 Internals

Macros
Ordinary functions
Generic functions
Classes

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Macros

Macro: make-readers (&rest bitlens) ¶

Package: fast-io.
Source: io.lisp.

Macro: make-writers (&rest bitlens) ¶

Package: fast-io.
Source: io.lisp.

Macro: read-unsigned-be (size buffer) ¶

Package: fast-io.
Source: io.lisp.

Macro: read-unsigned-le (size buffer) ¶

Package: fast-io.
Source: io.lisp.

Macro: write-unsigned-be (value size buffer) ¶

Package: fast-io.
Source: io.lisp.

Macro: write-unsigned-le (value size buffer) ¶

Package: fast-io.
Source: io.lisp.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: concat-buffer (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: copy-input-buffer (instance) ¶

Package: fast-io.
Source: io.lisp.

Function: copy-output-buffer (instance) ¶

Package: fast-io.
Source: io.lisp.

Function: extend (buffer &optional min) ¶

Package: fast-io.
Source: io.lisp.

Function: fast-peek-byte (input-buffer &optional peek-type eof-error-p eof-value) ¶

This is like ‘peek-byte’ only for fast-io input-buffers.

Package: fast-io.
Source: io.lisp.

Function: flush (output-buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: input-buffer-p (object) ¶

Package: fast-io.
Source: io.lisp.

Reader: input-buffer-pos (instance) ¶

Writer: (setf input-buffer-pos) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: pos.

Reader: output-buffer-fill (instance) ¶

Writer: (setf output-buffer-fill) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: fill.

Reader: output-buffer-last (instance) ¶

Writer: (setf output-buffer-last) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: last.

Reader: output-buffer-len (instance) ¶

Writer: (setf output-buffer-len) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: len.

Reader: output-buffer-output (instance) ¶

Writer: (setf output-buffer-output) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: output.

Function: output-buffer-p (object) ¶

Package: fast-io.
Source: io.lisp.

Reader: output-buffer-queue (instance) ¶

Writer: (setf output-buffer-queue) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: queue.

Reader: output-buffer-vector (instance) ¶

Writer: (setf output-buffer-vector) (instance) ¶

Package: fast-io.
Source: io.lisp.
Target Slot: vector.

Function: read24-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: read24-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu24-be (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: readu24-le (buffer) ¶

Package: fast-io.
Source: io.lisp.

Function: signed-to-unsigned (value size) ¶

Package: fast-io.
Source: io.lisp.

Function: unsigned-to-signed (value size) ¶

Package: fast-io.
Source: io.lisp.

Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.3 Generic functions

Generic Function: peek-byte (stream &optional peek-type eof-error-p eof-value) ¶

Package

fast-io.

Methods

Method: peek-byte ((stream fast-input-stream) &optional peek-type eof-error-p eof-value) ¶

Source: gray.lisp.

Previous: Generic functions, Up: Internals [Contents][Index]

5.2.4 Classes

Class: fast-io-stream ¶

Package

fast-io.

Source

gray.lisp.

Direct superclasses

fundamental-stream.

Direct subclasses

fast-input-stream.
fast-output-stream.

Direct methods

open-stream-p.
stream-file-position.

Direct slots

Slot: openp ¶

Type: boolean
Initform: t

Previous: Definitions, Up: The fast-io Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( B C E F G I M O P R S U W

	Index Entry	Section

(
	`(setf buffer-position)`:	Public ordinary functions
	`(setf input-buffer-pos)`:	Private ordinary functions
	`(setf input-buffer-stream)`:	Public ordinary functions
	`(setf input-buffer-vector)`:	Public ordinary functions
	`(setf output-buffer-fill)`:	Private ordinary functions
	`(setf output-buffer-last)`:	Private ordinary functions
	`(setf output-buffer-len)`:	Private ordinary functions
	`(setf output-buffer-output)`:	Private ordinary functions
	`(setf output-buffer-queue)`:	Private ordinary functions
	`(setf output-buffer-vector)`:	Private ordinary functions
	`(setf stream-file-position)`:	Public standalone methods

B
	`buffer-position`:	Public ordinary functions

C
	`close`:	Public standalone methods
	`close`:	Public standalone methods
	`concat-buffer`:	Private ordinary functions
	`copy-input-buffer`:	Private ordinary functions
	`copy-output-buffer`:	Private ordinary functions

E
	`extend`:	Private ordinary functions

F
	`fast-peek-byte`:	Private ordinary functions
	`fast-read-byte`:	Public ordinary functions
	`fast-read-sequence`:	Public ordinary functions
	`fast-write-byte`:	Public ordinary functions
	`fast-write-sequence`:	Public ordinary functions
	`finish-output-buffer`:	Public ordinary functions
	`finish-output-stream`:	Public ordinary functions
	`flush`:	Private ordinary functions
	`Function, (setf buffer-position)`:	Public ordinary functions
	`Function, (setf input-buffer-pos)`:	Private ordinary functions
	`Function, (setf input-buffer-stream)`:	Public ordinary functions
	`Function, (setf input-buffer-vector)`:	Public ordinary functions
	`Function, (setf output-buffer-fill)`:	Private ordinary functions
	`Function, (setf output-buffer-last)`:	Private ordinary functions
	`Function, (setf output-buffer-len)`:	Private ordinary functions
	`Function, (setf output-buffer-output)`:	Private ordinary functions
	`Function, (setf output-buffer-queue)`:	Private ordinary functions
	`Function, (setf output-buffer-vector)`:	Private ordinary functions
	`Function, buffer-position`:	Public ordinary functions
	`Function, concat-buffer`:	Private ordinary functions
	`Function, copy-input-buffer`:	Private ordinary functions
	`Function, copy-output-buffer`:	Private ordinary functions
	`Function, extend`:	Private ordinary functions
	`Function, fast-peek-byte`:	Private ordinary functions
	`Function, fast-read-byte`:	Public ordinary functions
	`Function, fast-read-sequence`:	Public ordinary functions
	`Function, fast-write-byte`:	Public ordinary functions
	`Function, fast-write-sequence`:	Public ordinary functions
	`Function, finish-output-buffer`:	Public ordinary functions
	`Function, finish-output-stream`:	Public ordinary functions
	`Function, flush`:	Private ordinary functions
	`Function, input-buffer-p`:	Private ordinary functions
	`Function, input-buffer-pos`:	Private ordinary functions
	`Function, input-buffer-stream`:	Public ordinary functions
	`Function, input-buffer-vector`:	Public ordinary functions
	`Function, make-input-buffer`:	Public ordinary functions
	`Function, make-octet-vector`:	Public ordinary functions
	`Function, make-output-buffer`:	Public ordinary functions
	`Function, octets-from`:	Public ordinary functions
	`Function, output-buffer-fill`:	Private ordinary functions
	`Function, output-buffer-last`:	Private ordinary functions
	`Function, output-buffer-len`:	Private ordinary functions
	`Function, output-buffer-output`:	Private ordinary functions
	`Function, output-buffer-p`:	Private ordinary functions
	`Function, output-buffer-queue`:	Private ordinary functions
	`Function, output-buffer-vector`:	Private ordinary functions
	`Function, read128-be`:	Public ordinary functions
	`Function, read128-le`:	Public ordinary functions
	`Function, read16-be`:	Public ordinary functions
	`Function, read16-le`:	Public ordinary functions
	`Function, read24-be`:	Private ordinary functions
	`Function, read24-le`:	Private ordinary functions
	`Function, read32-be`:	Public ordinary functions
	`Function, read32-le`:	Public ordinary functions
	`Function, read64-be`:	Public ordinary functions
	`Function, read64-le`:	Public ordinary functions
	`Function, read8`:	Public ordinary functions
	`Function, read8-be`:	Public ordinary functions
	`Function, read8-le`:	Public ordinary functions
	`Function, readu128-be`:	Public ordinary functions
	`Function, readu128-le`:	Public ordinary functions
	`Function, readu16-be`:	Public ordinary functions
	`Function, readu16-le`:	Public ordinary functions
	`Function, readu24-be`:	Private ordinary functions
	`Function, readu24-le`:	Private ordinary functions
	`Function, readu32-be`:	Public ordinary functions
	`Function, readu32-le`:	Public ordinary functions
	`Function, readu64-be`:	Public ordinary functions
	`Function, readu64-le`:	Public ordinary functions
	`Function, readu8`:	Public ordinary functions
	`Function, readu8-be`:	Public ordinary functions
	`Function, readu8-le`:	Public ordinary functions
	`Function, signed-to-unsigned`:	Private ordinary functions
	`Function, unsigned-to-signed`:	Private ordinary functions
	`Function, write128-be`:	Public ordinary functions
	`Function, write128-le`:	Public ordinary functions
	`Function, write16-be`:	Public ordinary functions
	`Function, write16-le`:	Public ordinary functions
	`Function, write24-be`:	Public ordinary functions
	`Function, write24-le`:	Public ordinary functions
	`Function, write32-be`:	Public ordinary functions
	`Function, write32-le`:	Public ordinary functions
	`Function, write64-be`:	Public ordinary functions
	`Function, write64-le`:	Public ordinary functions
	`Function, write8`:	Public ordinary functions
	`Function, write8-be`:	Public ordinary functions
	`Function, write8-le`:	Public ordinary functions
	`Function, writeu128-be`:	Public ordinary functions
	`Function, writeu128-le`:	Public ordinary functions
	`Function, writeu16-be`:	Public ordinary functions
	`Function, writeu16-le`:	Public ordinary functions
	`Function, writeu24-be`:	Public ordinary functions
	`Function, writeu24-le`:	Public ordinary functions
	`Function, writeu32-be`:	Public ordinary functions
	`Function, writeu32-le`:	Public ordinary functions
	`Function, writeu64-be`:	Public ordinary functions
	`Function, writeu64-le`:	Public ordinary functions
	`Function, writeu8`:	Public ordinary functions
	`Function, writeu8-be`:	Public ordinary functions
	`Function, writeu8-le`:	Public ordinary functions

G
	`Generic Function, peek-byte`:	Private generic functions

I
	`initialize-instance`:	Public standalone methods
	`initialize-instance`:	Public standalone methods
	`input-buffer-p`:	Private ordinary functions
	`input-buffer-pos`:	Private ordinary functions
	`input-buffer-stream`:	Public ordinary functions
	`input-buffer-vector`:	Public ordinary functions
	`input-stream-p`:	Public standalone methods

M
	`Macro, make-readers`:	Private macros
	`Macro, make-writers`:	Private macros
	`Macro, read-unsigned-be`:	Private macros
	`Macro, read-unsigned-le`:	Private macros
	`Macro, with-fast-input`:	Public macros
	`Macro, with-fast-output`:	Public macros
	`Macro, write-unsigned-be`:	Private macros
	`Macro, write-unsigned-le`:	Private macros
	`make-input-buffer`:	Public ordinary functions
	`make-octet-vector`:	Public ordinary functions
	`make-output-buffer`:	Public ordinary functions
	`make-readers`:	Private macros
	`make-writers`:	Private macros
	`Method, (setf stream-file-position)`:	Public standalone methods
	`Method, close`:	Public standalone methods
	`Method, close`:	Public standalone methods
	`Method, initialize-instance`:	Public standalone methods
	`Method, initialize-instance`:	Public standalone methods
	`Method, input-stream-p`:	Public standalone methods
	`Method, open-stream-p`:	Public standalone methods
	`Method, output-stream-p`:	Public standalone methods
	`Method, peek-byte`:	Private generic functions
	`Method, stream-element-type`:	Public standalone methods
	`Method, stream-element-type`:	Public standalone methods
	`Method, stream-file-position`:	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

O
	`octets-from`:	Public ordinary functions
	`open-stream-p`:	Public standalone methods
	`output-buffer-fill`:	Private ordinary functions
	`output-buffer-last`:	Private ordinary functions
	`output-buffer-len`:	Private ordinary functions
	`output-buffer-output`:	Private ordinary functions
	`output-buffer-p`:	Private ordinary functions
	`output-buffer-queue`:	Private ordinary functions
	`output-buffer-vector`:	Private ordinary functions
	`output-stream-p`:	Public standalone methods

P
	`peek-byte`:	Private generic functions
	`peek-byte`:	Private generic functions

R
	`read-unsigned-be`:	Private macros
	`read-unsigned-le`:	Private macros
	`read128-be`:	Public ordinary functions
	`read128-le`:	Public ordinary functions
	`read16-be`:	Public ordinary functions
	`read16-le`:	Public ordinary functions
	`read24-be`:	Private ordinary functions
	`read24-le`:	Private ordinary functions
	`read32-be`:	Public ordinary functions
	`read32-le`:	Public ordinary functions
	`read64-be`:	Public ordinary functions
	`read64-le`:	Public ordinary functions
	`read8`:	Public ordinary functions
	`read8-be`:	Public ordinary functions
	`read8-le`:	Public ordinary functions
	`readu128-be`:	Public ordinary functions
	`readu128-le`:	Public ordinary functions
	`readu16-be`:	Public ordinary functions
	`readu16-le`:	Public ordinary functions
	`readu24-be`:	Private ordinary functions
	`readu24-le`:	Private ordinary functions
	`readu32-be`:	Public ordinary functions
	`readu32-le`:	Public ordinary functions
	`readu64-be`:	Public ordinary functions
	`readu64-le`:	Public ordinary functions
	`readu8`:	Public ordinary functions
	`readu8-be`:	Public ordinary functions
	`readu8-le`:	Public ordinary functions

S
	`signed-to-unsigned`:	Private ordinary functions
	`stream-element-type`:	Public standalone methods
	`stream-element-type`:	Public standalone methods
	`stream-file-position`:	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

U
	`unsigned-to-signed`:	Private ordinary functions

W
	`with-fast-input`:	Public macros
	`with-fast-output`:	Public macros
	`write-unsigned-be`:	Private macros
	`write-unsigned-le`:	Private macros
	`write128-be`:	Public ordinary functions
	`write128-le`:	Public ordinary functions
	`write16-be`:	Public ordinary functions
	`write16-le`:	Public ordinary functions
	`write24-be`:	Public ordinary functions
	`write24-le`:	Public ordinary functions
	`write32-be`:	Public ordinary functions
	`write32-le`:	Public ordinary functions
	`write64-be`:	Public ordinary functions
	`write64-le`:	Public ordinary functions
	`write8`:	Public ordinary functions
	`write8-be`:	Public ordinary functions
	`write8-le`:	Public ordinary functions
	`writeu128-be`:	Public ordinary functions
	`writeu128-le`:	Public ordinary functions
	`writeu16-be`:	Public ordinary functions
	`writeu16-le`:	Public ordinary functions
	`writeu24-be`:	Public ordinary functions
	`writeu24-le`:	Public ordinary functions
	`writeu32-be`:	Public ordinary functions
	`writeu32-le`:	Public ordinary functions
	`writeu64-be`:	Public ordinary functions
	`writeu64-le`:	Public ordinary functions
	`writeu8`:	Public ordinary functions
	`writeu8-be`:	Public ordinary functions
	`writeu8-le`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* B F L O P Q S V

	Index Entry	Section

*
	`default-output-buffer-size`:	Public special variables

B
	`buffer`:	Public classes
	`buffer`:	Public classes

F
	`fill`:	Public structures

L
	`last`:	Public structures
	`len`:	Public structures

O
	`openp`:	Private classes
	`output`:	Public structures

P
	`pos`:	Public structures

Q
	`queue`:	Public structures

S
	`Slot, buffer`:	Public classes
	`Slot, buffer`:	Public classes
	`Slot, fill`:	Public structures
	`Slot, last`:	Public structures
	`Slot, len`:	Public structures
	`Slot, openp`:	Private classes
	`Slot, output`:	Public structures
	`Slot, pos`:	Public structures
	`Slot, queue`:	Public structures
	`Slot, stream`:	Public structures
	`Slot, vector`:	Public structures
	`Slot, vector`:	Public structures
	`Special Variable, default-output-buffer-size`:	Public special variables
	`stream`:	Public structures

V
	`vector`:	Public structures
	`vector`:	Public structures

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

A.4 Data types

Jump to:	C F G I O P S T

	Index Entry	Section

C
	`Class, fast-input-stream`:	Public classes
	`Class, fast-io-stream`:	Private classes
	`Class, fast-output-stream`:	Public classes

F
	`fast-input-stream`:	Public classes
	`fast-io`:	The fast-io system
	`fast-io`:	The fast-io package
	`fast-io-stream`:	Private classes
	`fast-io.asd`:	The fast-io/fast-io․asd file
	`fast-output-stream`:	Public classes
	`File, fast-io.asd`:	The fast-io/fast-io․asd file
	`File, gray.lisp`:	The fast-io/gray․lisp file
	`File, io.lisp`:	The fast-io/io․lisp file
	`File, package.lisp`:	The fast-io/package․lisp file
	`File, types.lisp`:	The fast-io/types․lisp file

G
	`gray.lisp`:	The fast-io/gray․lisp file

I
	`index`:	Public types
	`input-buffer`:	Public structures
	`io.lisp`:	The fast-io/io․lisp file

O
	`octet`:	Public types
	`octet-vector`:	Public types
	`output-buffer`:	Public structures

P
	`Package, fast-io`:	The fast-io package
	`package.lisp`:	The fast-io/package․lisp file

S
	`Structure, input-buffer`:	Public structures
	`Structure, output-buffer`:	Public structures
	`System, fast-io`:	The fast-io system

T
	`Type, index`:	Public types
	`Type, octet`:	Public types
	`Type, octet-vector`:	Public types
	`types.lisp`:	The fast-io/types․lisp file

The fast-io Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 fast-io

3 Files

3.1 Lisp

3.1.1 fast-io/fast-io.asd

3.1.2 fast-io/package.lisp

3.1.3 fast-io/types.lisp

3.1.4 fast-io/io.lisp

3.1.5 fast-io/gray.lisp

4 Packages

4.1 fast-io

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Macros

5.1.3 Ordinary functions

5.1.4 Standalone methods

5.1.5 Structures

5.1.6 Classes

5.1.7 Types

5.2 Internals

5.2.1 Macros

5.2.2 Ordinary functions

5.2.3 Generic functions

5.2.4 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `fast-io`

3.1.1 `fast-io/fast-io.asd`

3.1.2 `fast-io/package.lisp`

3.1.3 `fast-io/types.lisp`

3.1.4 `fast-io/io.lisp`

3.1.5 `fast-io/gray.lisp`

4.1 `fast-io`