The cl-plumbing Reference Manual

Table of Contents

The cl-plumbing Reference Manual

This is the cl-plumbing Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:28:24 2020 GMT+0.

1 Introduction

* CL-Plumbing

This library adds a few stream manipulation facilities that I haven't been able
to figure out using CL's stream facilities.  These include:

=make-pipe=: Make a two way stream (though not of type two-way-stream) that
accepts data (via writing to it) and that data can then be read from it.  This
is similar to the piping mechanism in the shell.

=connect-streams=: Take an input stream and an output stream and feed all data
from the input stream to the output stream.  Again, similar to the way shell
pipes act, but this is for two existing streams and the other creates two new
streams (well, one new two way stream).

** Future work

Just now it occurred to me that it would be cool to have this provide a CL
(gray) stream interface for ZeroMQ.  Most of the work is already done, I
believe...

2 Systems

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

2.1 cl-plumbing

Author

Zachary Smith <zachkostsmith@gmail.com>

License

LLGPL

Description

A few (at least seemingly) missing stream operations in Common Lisp.

Dependencies

• iterate
• trivial-gray-streams
• bordeaux-threads

Source

cl-plumbing.asd (file)

Components

• package.lisp (file)
• gray-streams-pipe.lisp (file)
• cl-plumbing.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 cl-plumbing.asd

Location

cl-plumbing.asd

Systems

cl-plumbing (system)

3.1.2 cl-plumbing/package.lisp

Parent

cl-plumbing (system)

Location

package.lisp

Packages

cl-plumbing

3.1.3 cl-plumbing/gray-streams-pipe.lisp

Dependency

package.lisp (file)

Parent

cl-plumbing (system)

Location

gray-streams-pipe.lisp

Exported Definitions

make-pipe (function)

Internal Definitions

• *block-size* (special variable)
• flush-in-to-out (function)
• input-of (method)
• (setf input-of) (method)
• lock-of (method)
• (setf lock-of) (method)
• output-of (method)
• (setf output-of) (method)
• pipe (class)

3.1.4 cl-plumbing/cl-plumbing.lisp

Dependency

gray-streams-pipe.lisp (file)

Parent

cl-plumbing (system)

Location

cl-plumbing.lisp

Exported Definitions

• *warn-on-foreground-connect-stream* (special variable)
• connect-streams (function)

Internal Definitions

dump-stream (function)

4 Packages

Packages are listed by definition order.

4.1 cl-plumbing

Source

package.lisp (file)

Use List

• iterate
• common-lisp

Exported Definitions

• *warn-on-foreground-connect-stream* (special variable)
• connect-streams (function)
• make-pipe (function)

Internal Definitions

• *block-size* (special variable)
• dump-stream (function)
• flush-in-to-out (function)
• input-of (generic function)
• input-of (method)
• (setf input-of) (method)
• (setf input-of) (generic function)
• lock-of (generic function)
• lock-of (method)
• (setf lock-of) (method)
• (setf lock-of) (generic function)
• output-of (generic function)
• output-of (method)
• (setf output-of) (method)
• (setf output-of) (generic function)
• pipe (class)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *warn-on-foreground-connect-stream*

Package

cl-plumbing

Source

cl-plumbing.lisp (file)

5.1.2 Functions

Function: connect-streams INPUT OUTPUT &key BACKGROUND FN

This reads from input and writes output until the end of input is found.

Package

cl-plumbing

Source

cl-plumbing.lisp (file)

Function: make-pipe ()

This makes a stream where you can write your output, then read it out elsewhere.

Package

cl-plumbing

Source

gray-streams-pipe.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *block-size*

Package

cl-plumbing

Source

gray-streams-pipe.lisp (file)

5.2.2 Functions

Function: dump-stream INPUT OUTPUT &optional FN

Package

cl-plumbing

Source

cl-plumbing.lisp (file)

Function: flush-in-to-out PIPE

Package

cl-plumbing

Source

gray-streams-pipe.lisp (file)

5.2.3 Generic functions

Generic Function: input-of OBJECT

Generic Function: (setf input-of) NEW-VALUE OBJECT

Package

cl-plumbing

Methods

Method: input-of (PIPE pipe)

automatically generated reader method

Source

gray-streams-pipe.lisp (file)

Method: (setf input-of) NEW-VALUE (PIPE pipe)

automatically generated writer method

Source

gray-streams-pipe.lisp (file)

Generic Function: lock-of OBJECT

Generic Function: (setf lock-of) NEW-VALUE OBJECT

Package

cl-plumbing

Methods

Method: lock-of (PIPE pipe)

automatically generated reader method

Source

gray-streams-pipe.lisp (file)

Method: (setf lock-of) NEW-VALUE (PIPE pipe)

automatically generated writer method

Source

gray-streams-pipe.lisp (file)

Generic Function: output-of OBJECT

Generic Function: (setf output-of) NEW-VALUE OBJECT

Package

cl-plumbing

Methods

Method: output-of (PIPE pipe)

automatically generated reader method

Source

gray-streams-pipe.lisp (file)

Method: (setf output-of) NEW-VALUE (PIPE pipe)

automatically generated writer method

Source

gray-streams-pipe.lisp (file)

5.2.4 Classes

Class: pipe ()

Package

cl-plumbing

Source

gray-streams-pipe.lisp (file)

Direct superclasses

• trivial-gray-stream-mixin (class)
• fundamental-output-stream (class)
• fundamental-input-stream (class)

Direct methods

• close (method)
• stream-line-column (method)
• stream-write-sequence (method)
• stream-read-sequence (method)
• stream-read-line (method)
• stream-unread-char (method)
• stream-read-char-no-hang (method)
• stream-read-char (method)
• stream-write-char (method)
• output-of (method)
• output-of (method)
• input-of (method)
• input-of (method)
• lock-of (method)
• lock-of (method)

Direct slots

Slot: lock

Initform

(bordeaux-threads:make-lock)

Readers

lock-of (generic function)

Writers

(setf lock-of) (generic function)

Slot: input

Initargs

:input

Readers

input-of (generic function)

Writers

(setf input-of) (generic function)

Slot: output

Initargs

:output

Readers

output-of (generic function)

Writers

(setf output-of) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types