The cl-octet-streams Reference Manual

Table of Contents

The cl-octet-streams Reference Manual

This is the cl-octet-streams Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:25:38 2020 GMT+0.

1 Introduction

#+TITLE: cl-octet-streams

*cl-octet-streams* is a library implementing in-memory octet streams for Common Lisp.
It was inspired by the [[https://github.com/sharplispers/trivial-octet-streams][trivial-octet-streams]] and [[https://github.com/smithzvk/cl-plumbing][cl-plumbing]] libraries.

* Installation

The only dependency is the [[https://common-lisp.net/project/trivial-gray-streams][trivial-gray-streams]] library.

* API
** Input stream

#+BEGIN_SRC lisp
(make-octet-input-stream seq &optional (start 0) end) => stream
#+END_SRC

Return an input stream which will supply the bytes of /seq/ between /start/ and
/end/ in order.

#+BEGIN_SRC lisp
(with-octet-input-stream (var seq &optional (start 0) end) &body body)
#+END_SRC

Within /body/, /var/ is bound to an octet input stream defined by /seq/, /start/
and /end/. The result of the last form of /body/ is returned.

** Output stream

#+BEGIN_SRC lisp
(make-octet-output-stream) => stream
#+END_SRC

Return an output stream which will accumulate all the bytes written to it for
the benefit of the function /get-output-stream-octets/.

#+BEGIN_SRC lisp
(get-output-stream-octets stream) => bytes
#+END_SRC

Return the bytes that were written to an octet output /stream/.

#+BEGIN_SRC lisp
(with-octet-output-stream (var) &body body) => bytes
#+END_SRC

Within /body/, /var/ is bound to an octet output stream. After all the forms in
/body/ have been executed, the bytes that have been written to /var/ (and that
haven't been consumed by a call to /get-output-stream-octets/ within /body/) are
returned.

** Pipe

#+BEGIN_SRC lisp
(make-octet-pipe) => stream
#+END_SRC

Return a stream which will supply the bytes that have been written to it in
order.

#+BEGIN_SRC lisp
(with-octet-pipe (var) &body body)
#+END_SRC

Within /body/, /var/ is bound to an octet pipe. The result of the last form of
/body/ is returned.

** Connected streams

#+BEGIN_SRC lisp
(make-connected-octet-streams) => stream1, stream2
#+END_SRC

Return two streams connected to each other. The bytes written to the first
stream can be read from the second, and the bytes written to the second stream
can be read from the first.

#+BEGIN_SRC lisp
(with-connected-octet-streams (var1 var2) &body body)
#+END_SRC

Within /body/, /var1/ and /var2/ are bound to octet streams connected to each
other. The result of the last form of /body/ is returned.

* Tests

The tests require the [[https://common-lisp.net/project/fiveam][fiveam]] library.

#+BEGIN_SRC lisp
(asdf:test-system "cl-octet-streams")
#+END_SRC

2 Systems

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

2.1 cl-octet-streams

Author

Guillaume LE VAILLANT

License

GPL-3

Description

In-memory octet streams

Version

1.0

Dependency

trivial-gray-streams

Source

cl-octet-streams.asd (file)

Component

src (module)

3 Modules

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

3.1 cl-octet-streams/src

Parent

cl-octet-streams (system)

Location

src/

Components

• package.lisp (file)
• octet-streams.lisp (file)
• octet-pipes.lisp (file)
• connected-octet-streams.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 cl-octet-streams.asd

Location

cl-octet-streams.asd

Systems

cl-octet-streams (system)

4.1.2 cl-octet-streams/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

octet-streams

4.1.3 cl-octet-streams/src/octet-streams.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/octet-streams.lisp

Exported Definitions

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

Internal Definitions

• index (type)
• octet-input-stream (class)
• octet-output-stream (class)
• octet-stream (class)
• octet-stream-buffer (method)
• (setf octet-stream-buffer) (method)
• octet-stream-buffer-end (method)
• (setf octet-stream-buffer-end) (method)
• octet-stream-buffer-start (method)
• (setf octet-stream-buffer-start) (method)
• replace-fast (function)
• simple-octet-vector (type)

4.1.4 cl-octet-streams/src/octet-pipes.lisp

Dependency

octet-streams.lisp (file)

Parent

src (module)

Location

src/octet-pipes.lisp

Exported Definitions

• make-octet-pipe (function)
• with-octet-pipe (macro)

Internal Definitions

octet-pipe (class)

4.1.5 cl-octet-streams/src/connected-octet-streams.lisp

Dependency

octet-pipes.lisp (file)

Parent

src (module)

Location

src/connected-octet-streams.lisp

Exported Definitions

• make-connected-octet-streams (function)
• with-connected-octet-streams (macro)

5 Packages

Packages are listed by definition order.

5.1 octet-streams

Source

package.lisp (file)

Nickname

cl-octet-streams

Use List

• trivial-gray-streams
• common-lisp

Exported Definitions

• get-output-stream-octets (function)
• make-connected-octet-streams (function)
• make-octet-input-stream (function)
• make-octet-output-stream (function)
• make-octet-pipe (function)
• with-connected-octet-streams (macro)
• with-octet-input-stream (macro)
• with-octet-output-stream (macro)
• with-octet-pipe (macro)

Internal Definitions

• index (type)
• octet-input-stream (class)
• octet-output-stream (class)
• octet-pipe (class)
• octet-stream (class)
• octet-stream-buffer (generic function)
• octet-stream-buffer (method)
• (setf octet-stream-buffer) (method)
• (setf octet-stream-buffer) (generic function)
• octet-stream-buffer-end (generic function)
• octet-stream-buffer-end (method)
• (setf octet-stream-buffer-end) (method)
• (setf octet-stream-buffer-end) (generic function)
• octet-stream-buffer-start (generic function)
• octet-stream-buffer-start (method)
• (setf octet-stream-buffer-start) (method)
• (setf octet-stream-buffer-start) (generic function)
• replace-fast (function)
• simple-octet-vector (type)

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: with-connected-octet-streams (VAR1 VAR2) &body BODY

Within BODY, VAR1 and VAR2 are bound to octet streams connected to each other. The result of the last form of BODY is returned.

Package

octet-streams

Source

connected-octet-streams.lisp (file)

Macro: with-octet-input-stream (VAR SEQ &optional START END) &body BODY

Within BODY, VAR is bound to an octet input stream defined by SEQ, START and END. The result of the last form of BODY is returned.

Package

octet-streams

Source

octet-streams.lisp (file)

Macro: with-octet-output-stream (VAR) &body BODY

Within BODY, VAR is bound to an octet output stream. After all the forms in BODY have been executed, the bytes that have been written to VAR (and that haven’t been consumed by a call to GET-OUTPUT-STREAM-OCTETS within BODY) are returned.

Package

octet-streams

Source

octet-streams.lisp (file)

Macro: with-octet-pipe (VAR) &body BODY

Within BODY, VAR is bound to an octet pipe. The result of the last form of BODY is returned.

Package

octet-streams

Source

octet-pipes.lisp (file)

6.1.2 Functions

Function: get-output-stream-octets STREAM

Return the bytes that were written to an octet output STREAM.

Package

octet-streams

Source

octet-streams.lisp (file)

Function: make-connected-octet-streams ()

Return two streams connected to each other. The bytes written to the first stream can be read from the second, and the bytes written to the second stream can be read from the first.

Package

octet-streams

Source

connected-octet-streams.lisp (file)

Function: make-octet-input-stream SEQ &optional START END

Return an input stream which will supply the bytes of SEQ between START and END in order.

Package

octet-streams

Source

octet-streams.lisp (file)

Function: make-octet-output-stream ()

Return an output stream which will accumulate all the bytes written to it for the benefit of the function GET-OUTPUT-STREAM-OCTETS.

Package

octet-streams

Source

octet-streams.lisp (file)

Function: make-octet-pipe ()

Return a stream which will supply the bytes that have been written to it in order.

Package

octet-streams

Source

octet-pipes.lisp (file)

6.2 Internal definitions

6.2.1 Functions

Function: replace-fast BUFFER1 BUFFER2 START1 END1 START2 END2

Package

octet-streams

Source

octet-streams.lisp (file)

6.2.2 Generic functions

Generic Function: octet-stream-buffer OBJECT

Generic Function: (setf octet-stream-buffer) NEW-VALUE OBJECT

Package

octet-streams

Methods

Method: octet-stream-buffer (OCTET-STREAM octet-stream)

automatically generated reader method

Source

octet-streams.lisp (file)

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

automatically generated writer method

Source

octet-streams.lisp (file)

Generic Function: octet-stream-buffer-end OBJECT

Generic Function: (setf octet-stream-buffer-end) NEW-VALUE OBJECT

Package

octet-streams

Methods

Method: octet-stream-buffer-end (OCTET-STREAM octet-stream)

automatically generated reader method

Source

octet-streams.lisp (file)

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

automatically generated writer method

Source

octet-streams.lisp (file)

Generic Function: octet-stream-buffer-start OBJECT

Generic Function: (setf octet-stream-buffer-start) NEW-VALUE OBJECT

Package

octet-streams

Methods

Method: octet-stream-buffer-start (OCTET-STREAM octet-stream)

automatically generated reader method

Source

octet-streams.lisp (file)

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

automatically generated writer method

Source

octet-streams.lisp (file)

6.2.3 Classes

Class: octet-input-stream ()

Package

octet-streams

Source

octet-streams.lisp (file)

Direct superclasses

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

Direct subclasses

octet-pipe (class)

Direct methods

• stream-clear-input (method)
• stream-read-sequence (method)
• stream-read-byte (method)
• stream-listen (method)

Class: octet-output-stream ()

Package

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)

Class: octet-pipe ()

Package

octet-streams

Source

octet-pipes.lisp (file)

Direct superclasses

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

Direct methods

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

Class: octet-stream ()

Package

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)
• octet-stream-buffer-end (method)
• octet-stream-buffer-end (method)
• octet-stream-buffer-start (method)
• octet-stream-buffer-start (method)
• octet-stream-buffer (method)
• octet-stream-buffer (method)

Direct slots

Slot: buffer

Type

octet-streams::simple-octet-vector

Initargs

:buffer

Readers

octet-stream-buffer (generic function)

Writers

(setf octet-stream-buffer) (generic function)

Slot: buffer-start

Type

octet-streams::index

Initargs

:buffer-start

Readers

octet-stream-buffer-start (generic function)

Writers

(setf octet-stream-buffer-start) (generic function)

Slot: buffer-end

Type

octet-streams::index

Initargs

:buffer-end

Readers

octet-stream-buffer-end (generic function)

Writers

(setf octet-stream-buffer-end) (generic function)

6.2.4 Types

Type: index ()

Package

octet-streams

Source

octet-streams.lisp (file)

Type: simple-octet-vector ()

Package

octet-streams

Source

octet-streams.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types