This is the cl-bus Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:42:56 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-busA(n almost) referentially transparent interface for streams
Thomas Bartscher <thomas-bartscher@weltraumschlangen.de>
BSD-3
0.0.1
package.lisp (file).
cl-bus.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-bus/cl-bus.lisppackage.lisp (file).
cl-bus (system).
buffer<- (function).
bus (structure).
bus-advance (function).
bus-consume (function).
bus-read (function).
bus<- (generic function).
with-bus (macro).
with-file-bus (macro).
bus-buffer (reader).
(setf bus-buffer) (writer).
bus-child (reader).
(setf bus-child) (writer).
bus-p (function).
bus-stream (reader).
(setf bus-stream) (writer).
copy-bus (function).
make-bus (function).
Packages are listed by definition order.
cl-buscommon-lisp.
buffer<- (function).
bus (structure).
bus-advance (function).
bus-consume (function).
bus-read (function).
bus<- (generic function).
with-bus (macro).
with-file-bus (macro).
bus-buffer (reader).
(setf bus-buffer) (writer).
bus-child (reader).
(setf bus-child) (writer).
bus-p (function).
bus-stream (reader).
(setf bus-stream) (writer).
copy-bus (function).
make-bus (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns the buffer of the bus.
Returns two values. The second value is NIL if advancing failed and T
otherwise. The first value is a bus that starts reading LENGTH characters into
BUS if advancing succeeded or an empty bus if advancing failed.
Advancing fails when LENGTH is greater than the length of the buffer of BUS.
Returns three values: First a string as in BUS-READ, second a bus as in BUS-ADVANCE, third T if reading succeeded as in BUS-READ, NIL otherwise.
Returns two values. The second value is NIL if reading failed and T otherwise. The first value is a string of length LENGTH when reading succeeded, or a shorter string if reading failed. Reading fails when EOF is reached while reading from the underlying stream of BUS or when BUS does not have an underlying stream.
Takes a string, bus, or stream and returns a bus that reads across that string or stream
| Jump to: | (
B C F G M W |
|---|
| Jump to: | (
B C F G M W |
|---|
| Jump to: | B C S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| B | |||
buffer: | Public structures | ||
| | |||
| C | |||
child: | Public structures | ||
| | |||
| S | |||
Slot, buffer: | Public structures | ||
Slot, child: | Public structures | ||
Slot, stream: | Public structures | ||
stream: | Public structures | ||
| | |||
| Jump to: | B C S |
|---|
| Jump to: | B C F P S |
|---|
| Jump to: | B C F P S |
|---|