This is the cl-stream Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:45:11 2024 GMT+0.
cl-stream/cl-stream.asdcl-stream/buffered-input-stream.lispcl-stream/buffered-io-stream.lispcl-stream/buffered-output-stream.lispcl-stream/character-stream.lispcl-stream/cl-stream.lispcl-stream/conditions.lispcl-stream/input-stream.lispcl-stream/input-stream-1.lispcl-stream/io-stream.lispcl-stream/line-tracking-stream.lispcl-stream/misc.lispcl-stream/multi-buffered-output-stream.lispcl-stream/output-stream.lispcl-stream/package.lispcl-stream/queue.lispcl-stream/sequence-input-stream.lispcl-stream/sequence-output-stream.lispcl-stream/stdio.lispcl-stream/stream.lispcl-stream/string-output-stream.lispcl-stream/super-stream.lispcl-stream/ub8-stream.lispcl-stream/vector-output-stream.lispThe main system appears first, followed by any subsystem dependency.
cl-streamStream classes for Common Lisp
Thomas de Grivel <thoxdg@gmail.com>
0.1
buffered-input-stream.lisp (file).
buffered-io-stream.lisp (file).
buffered-output-stream.lisp (file).
character-stream.lisp (file).
cl-stream.lisp (file).
conditions.lisp (file).
input-stream.lisp (file).
input-stream-1.lisp (file).
io-stream.lisp (file).
line-tracking-stream.lisp (file).
misc.lisp (file).
multi-buffered-output-stream.lisp (file).
output-stream.lisp (file).
package.lisp (file).
queue.lisp (file).
sequence-input-stream.lisp (file).
sequence-output-stream.lisp (file).
stdio.lisp (file).
stream.lisp (file).
string-output-stream.lisp (file).
super-stream.lisp (file).
ub8-stream.lisp (file).
vector-output-stream.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-stream/cl-stream.asdcl-stream/buffered-input-stream.lispcl-stream/buffered-io-stream.lispcl-stream/buffered-output-stream.lispcl-stream/character-stream.lispcl-stream/cl-stream.lispcl-stream/conditions.lispcl-stream/input-stream.lispcl-stream/input-stream-1.lispcl-stream/io-stream.lispcl-stream/line-tracking-stream.lispcl-stream/misc.lispcl-stream/multi-buffered-output-stream.lispcl-stream/output-stream.lispcl-stream/package.lispcl-stream/queue.lispcl-stream/sequence-input-stream.lispcl-stream/sequence-output-stream.lispcl-stream/stdio.lispcl-stream/stream.lispcl-stream/string-output-stream.lispcl-stream/super-stream.lispcl-stream/ub8-stream.lispcl-stream/vector-output-stream.lispcl-stream/buffered-input-stream.lispinput-stream.lisp (file).
cl-stream (system).
buffered-input-stream (class).
make-stream-input-buffer (generic function).
stream-fill-input-buffer (generic function).
stream-input-buffer (generic function).
(setf stream-input-buffer) (generic function).
stream-input-buffer-size (reader method).
stream-input-index (reader method).
(setf stream-input-index) (writer method).
stream-input-length (reader method).
(setf stream-input-length) (writer method).
stream-read (method).
stream-read-element-from-buffer (generic function).
discard-stream-input-buffer (generic function).
stream-close (method).
cl-stream/buffered-io-stream.lispbuffered-input-stream.lisp (file).
buffered-output-stream.lisp (file).
io-stream.lisp (file).
cl-stream (system).
stream-copy (method).
cl-stream/buffered-output-stream.lispoutput-stream.lisp (file).
cl-stream (system).
buffered-output-stream (class).
make-stream-output-buffer (generic function).
stream-discard-output-buffer (method).
stream-discard-output-buffer (method).
stream-element-type (method).
stream-flush (method).
stream-flush-output (generic function).
stream-output-buffer (generic function).
(setf stream-output-buffer) (generic function).
stream-output-buffer-size (reader method).
stream-output-index (reader method).
(setf stream-output-index) (writer method).
stream-output-length (reader method).
(setf stream-output-length) (writer method).
stream-write (method).
stream-write-element-to-buffer (generic function).
stream-write-sequence (method).
stream-buffer-element (generic function).
stream-clear-output (generic function).
stream-close (method).
stream-close (method).
cl-stream/character-stream.lispstream.lisp (file).
cl-stream (system).
character-stream (class).
stream-element-type (method).
cl-stream/cl-stream.lispbuffered-io-stream.lisp (file).
cl-stream (system).
stream-element-type (method).
stream-open-p (method).
stream-read (method).
stream-read-sequence (method).
stream-write (method).
stream-write (method).
stream-write-sequence (method).
stream-close (method).
stream-finish-output (method).
cl-stream/conditions.lisppackage.lisp (file).
cl-stream (system).
end-of-file (condition).
non-blocking (condition).
stream-condition (condition).
stream-condition-stream (reader method).
cl-stream/input-stream.lispstream.lisp (file).
cl-stream (system).
input-stream (class).
stream-discard-n (generic function).
stream-input-error (condition).
stream-read (generic function).
stream-read-sequence (generic function).
stream-read-sequence-until (generic function).
stream-read-until (generic function).
cl-stream/input-stream-1.lispvector-output-stream.lisp (file).
cl-stream (system).
stream-read-line (generic function).
stream-read-until (method).
cl-stream/io-stream.lispinput-stream.lisp (file).
output-stream.lisp (file).
cl-stream (system).
io-stream (class).
stream-copy (generic function).
stream-copy-n (generic function).
cl-stream/line-tracking-stream.lispcharacter-stream.lisp (file).
input-stream.lisp (file).
super-stream.lisp (file).
cl-stream (system).
stream-read (method).
line-tracking-input-stream (class).
stream-input-column (reader method).
(setf stream-input-column) (writer method).
stream-input-line (reader method).
(setf stream-input-line) (writer method).
cl-stream/misc.lisppackage.lisp (file).
cl-stream (system).
+eof+ (constant).
fixnum+ (type).
shadowing-import-from (function).
cl-stream/multi-buffered-output-stream.lispbuffered-output-stream.lisp (file).
cl-stream (system).
make-stream-output-buffer (method).
multi-buffered-output-stream (function).
multi-buffered-output-stream (class).
stream-discard-output-buffer (method).
stream-element-type (method).
stream-flush-output (method).
stream-open-p (method).
stream-underlying-stream (reader method).
stream-write (method).
stream-write-sequence (method).
multi-buffer-output (generic function).
multi-buffer-write (generic function).
queue-new-buffer (function).
stream-close (method).
cl-stream/output-stream.lispstream.lisp (file).
cl-stream (system).
output-stream (class).
stream-flush (generic function).
stream-output-error (condition).
stream-write (generic function).
stream-write-sequence (generic function).
cl-stream/queue.lispio-stream.lisp (file).
cl-stream (system).
queue (class).
queue-first (generic function).
(setf queue-first) (generic function).
queue-length (reader method).
(setf queue-length) (writer method).
stream-blocking-p (method).
stream-element-type (reader method).
(setf stream-element-type) (writer method).
stream-read (method).
stream-write (method).
make-queue-buffer (generic function).
queue-buffer (generic function).
queue-buffer-size (reader method).
(setf queue-buffer-size) (writer method).
queue-last (method).
queue-read-index (reader method).
(setf queue-read-index) (writer method).
queue-write-index (reader method).
(setf queue-write-index) (writer method).
cl-stream/sequence-input-stream.lispbuffered-input-stream.lisp (file).
cl-stream (system).
initialize-instance (method).
sequence-input-stream (function).
sequence-input-stream (class).
stream-element-type (method).
stream-fill-input-buffer (method).
stream-input-buffer-size (method).
stream-input-length (method).
stream-open-p (method).
string-input-stream (function).
stream-close (method).
cl-stream/sequence-output-stream.lispbuffered-output-stream.lisp (file).
cl-stream (system).
sequence-output-stream (class).
sequence-output-stream-reset (generic function).
sequence-output-stream-sequence (generic function).
stream-element-type (reader method).
stream-open-p (reader method).
(setf stream-open-p) (writer method).
stream-close (method).
cl-stream/stdio.lispio-stream.lisp (file).
cl-stream (system).
cl-stream/stream.lisppackage.lisp (file).
misc.lisp (file).
cl-stream (system).
*stream-default-buffer-size* (special variable).
stream (class).
stream-blocking-p (generic function).
(setf stream-blocking-p) (generic function).
stream-closed-error (condition).
stream-element-type (generic function).
stream-end-error (condition).
stream-error (condition).
stream-error-stream (reader method).
stream-open-p (generic function).
with-stream (macro).
check-if-open (generic function).
stream-close (generic function).
cl-stream/string-output-stream.lispsequence-output-stream.lisp (file).
cl-stream (system).
initialize-instance (method).
string-output-stream (function).
string-output-stream (class).
with-output-to-string (macro).
cl-stream/super-stream.lispbuffered-output-stream.lisp (file).
cl-stream (system).
stream-flush (method).
stream-flush-output (method).
stream-open-p (method).
stream-underlying-stream (reader method).
super-stream (class).
stream-clear-output (method).
stream-close (method).
cl-stream/ub8-stream.lispstream.lisp (file).
cl-stream (system).
stream-element-type (method).
ub8-stream (class).
cl-stream/vector-output-stream.lispbuffered-output-stream.lisp (file).
cl-stream (system).
make-stream-output-buffer (method).
sequence-output-stream-reset (method).
stream-flush (method).
stream-flush-output (method).
stream-write-element-to-buffer (method).
vector-output-stream (class).
with-output-to-vector (macro).
Packages are listed by definition order.
cl-streamstream
common-lisp.
*stderr* (special variable).
*stdin* (special variable).
*stdout* (special variable).
*stream-default-buffer-size* (special variable).
+eof+ (constant).
buffered-input-stream (class).
buffered-output-stream (class).
character-stream (class).
end-of-file (condition).
fixnum+ (type).
input-stream (class).
io-stream (class).
make-stream-input-buffer (generic function).
make-stream-output-buffer (generic function).
multi-buffered-output-stream (function).
multi-buffered-output-stream (class).
non-blocking (condition).
output-stream (class).
queue (class).
queue-first (generic function).
(setf queue-first) (generic function).
queue-length (generic reader).
(setf queue-length) (generic writer).
read (function).
sequence-input-stream (function).
sequence-input-stream (class).
sequence-output-stream (class).
sequence-output-stream-reset (generic function).
sequence-output-stream-sequence (generic function).
shadowing-import-from (function).
stream (class).
stream-blocking-p (generic function).
(setf stream-blocking-p) (generic function).
stream-closed-error (condition).
stream-condition (condition).
stream-condition-stream (generic reader).
stream-copy (generic function).
stream-copy-n (generic function).
stream-discard-n (generic function).
stream-discard-output-buffer (generic function).
stream-element-type (generic function).
(setf stream-element-type) (generic writer).
stream-end-error (condition).
stream-error (condition).
stream-error-stream (generic reader).
stream-fill-input-buffer (generic function).
stream-flush (generic function).
stream-flush-output (generic function).
stream-input-buffer (generic function).
(setf stream-input-buffer) (generic function).
stream-input-buffer-size (generic function).
stream-input-error (condition).
stream-input-index (generic reader).
(setf stream-input-index) (generic writer).
stream-input-length (generic function).
(setf stream-input-length) (generic writer).
stream-open-p (generic function).
(setf stream-open-p) (generic writer).
stream-output-buffer (generic function).
(setf stream-output-buffer) (generic function).
stream-output-buffer-size (generic reader).
stream-output-error (condition).
stream-output-index (generic reader).
(setf stream-output-index) (generic writer).
stream-output-length (generic reader).
(setf stream-output-length) (generic writer).
stream-read (generic function).
stream-read-element-from-buffer (generic function).
stream-read-line (generic function).
stream-read-sequence (generic function).
stream-read-sequence-until (generic function).
stream-read-until (generic function).
stream-underlying-stream (generic reader).
stream-write (generic function).
stream-write-element-to-buffer (generic function).
stream-write-sequence (generic function).
string-input-stream (function).
string-output-stream (function).
string-output-stream (class).
super-stream (class).
ub8-stream (class).
with-output-to-string (macro).
with-stream (macro).
write (function).
check-if-open (generic function).
discard-stream-input-buffer (generic function).
line-tracking-input-stream (class).
make-queue-buffer (generic function).
multi-buffer-output (generic function).
multi-buffer-write (generic function).
queue-buffer (generic function).
queue-buffer-size (generic reader).
(setf queue-buffer-size) (generic writer).
queue-last (generic function).
queue-new-buffer (function).
queue-read-index (generic reader).
(setf queue-read-index) (generic writer).
queue-write-index (generic reader).
(setf queue-write-index) (generic writer).
stream-buffer-element (generic function).
stream-clear-output (generic function).
stream-close (generic function).
stream-finish-output (generic function).
stream-input-column (generic reader).
(setf stream-input-column) (generic writer).
stream-input-line (generic reader).
(setf stream-input-line) (generic writer).
vector-output-stream (class).
with-output-to-vector (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Binds VAR to a new sequence output stream with element-type
character. Returns the sequence output stream string if
BODY returns normally. The stream is closed after BODY returns
normally or before it is aborted by a control transfer of some kind.
Ensures STREAM gets closed returning from BODY with VAR bound to STREAM.
Returns a new sequence input stream reading from SEQUENCE.
Returns a new sequence input stream reading from STRING.
Returns a new input buffer for stream.
buffered-input-stream)) ¶Returns a new output buffer for stream.
multi-buffered-output-stream)) ¶vector-output-stream)) ¶Resets SEQUENCE-OUTPUT-STREAM to an empty sequence.
vector-output-stream)) ¶Returns the sequence that was written to SEQUENCE-OUTPUT-STREAM.
sequence-output-stream)) ¶Returns T if STREAM is in blocking mode, or NIL if in non-blocking mode.
Set to T to put STREAM in blocking mode, or NIL for non-blocking mode.
stream-condition)) ¶buffered-input-stream) (out buffered-output-stream)) ¶integer)) ¶Discard COUNT items from INPUT-STREAM.
integer)) ¶multi-buffered-output-stream)) ¶buffered-output-stream)) ¶Returns the type of elements of STREAM.
ub8-stream)) ¶sequence-output-stream)) ¶automatically generated reader method
sequence-input-stream)) ¶queue)) ¶automatically generated reader method
multi-buffered-output-stream)) ¶stream)) ¶character-stream)) ¶buffered-output-stream)) ¶stream-error)) ¶Fills the stream input buffer.
Returns NIL if successful, or
:EOF if end of file was reached, or
:NON-BLOCKING if operation would block.
sequence-input-stream)) ¶Ensure that any output buffer is fully transmitted.
Returns a state indicator which is NIL if flush succeeded,
:EOF if end of file was reached, or
:NON-BLOCKING if flush would block.
super-stream)) ¶vector-output-stream)) ¶buffered-output-stream)) ¶Flushes the output buffer of BUFFERED-OUTPUT-STREAM
by repeatedly calling STREAM-FLUSH-OUTPUT until empty. Returns
NIL if output buffer was empty or emptied, or
:EOF if end of file was reached, or
:NON-BLOCKING if write would block.
output-stream)) ¶Tries to flush once the stream output buffer. Returns
NIL if the output buffer was partially or completely flushed, or
:EOF if end of file was reached, or
:NON-BLOCKING if operation would block.
multi-buffered-output-stream)) ¶super-stream)) ¶vector-output-stream)) ¶buffered-output-stream)) ¶Returns the stream input buffer, calling MAKE-STREAM-INPUT-BUFFER to create it if needed.
buffered-input-stream)) ¶Sets the stream input buffer.
buffered-input-stream)) ¶sequence-input-stream)) ¶buffered-input-stream)) ¶automatically generated reader method
buffered-input-stream)) ¶automatically generated reader method
buffered-input-stream)) ¶automatically generated writer method
sequence-input-stream)) ¶buffered-input-stream)) ¶automatically generated reader method
buffered-input-stream)) ¶automatically generated writer method
Returns T is STREAM is open, or NIL if closed.
sequence-output-stream)) ¶automatically generated reader method
sequence-input-stream)) ¶multi-buffered-output-stream)) ¶super-stream)) ¶stream)) ¶sequence-output-stream)) ¶automatically generated writer method
Returns the stream output buffer, calling MAKE-STREAM-OUTPUT-BUFFER to create it if needed.
buffered-output-stream)) ¶Sets the stream output buffer.
buffered-output-stream)) ¶buffered-output-stream)) ¶automatically generated reader method
buffered-output-stream)) ¶automatically generated reader method
buffered-output-stream)) ¶automatically generated writer method
buffered-output-stream)) ¶automatically generated reader method
buffered-output-stream)) ¶automatically generated writer method
Tries to read one element from STREAM.
Returns two values : the element or NIL if read failed;
and a state indicator which is
NIL if read succeeded,
:EOF if end of file was reached, or
:NON-BLOCKING if read would block.
line-tracking-input-stream)) ¶stream)) ¶buffered-input-stream)) ¶buffered-input-stream)) ¶character-stream)) ¶Reads elements from INPUT-STREAM into SEQ
from START to END. Returns two values :
the number of elements read, and
a state indicator which is
NIL if STREAM-READ-SEQUENCE succeeded
:EOF if end of file was reached
:NON-BLOCKING if read would block.
stream) (seq sequence) &key start end) ¶input-stream) seq &key start end) ¶Reads elements from INPUT-STREAM into SEQ
from START to END until END-ELEMENT is read. Returns two values :
the number of elements read, and
a state indicator which is
NIL if STREAM-READ-SEQUENCE-UNTIL succeeded
:EOF if end of file was reached
:NON-BLOCKING if read would block.
input-stream) end-element seq &key start end) ¶Reads elements from INPUT-STREAM from START to END
until END-ELEMENT is read. Returns two values :
a sequence of elements read, and
a state indicator which is
NIL if READ-UNTIL succeeded
:EOF if end of file was reached
:NON-BLOCKING if read would block.
multi-buffered-output-stream)) ¶automatically generated reader method
super-stream)) ¶automatically generated reader method
Tries to write one element to STREAM.
Returns a state indicator which is NIL if write succeeded,
:EOF if end of file was reached, or
:NON-BLOCKING if write would block.
multi-buffered-output-stream) element) ¶stream) (element character)) ¶stream) (element integer)) ¶buffered-output-stream) element) ¶vector-output-stream) element) ¶Writes elements from SEQ from START to END
to OUTPUT-STREAM. Returns two values :
the number of elements written, and
a state indicator which is
NIL if WRITE-SEQUENCE succeeded
:EOF if end of file was reached
:NON-BLOCKING if write would block.
multi-buffered-output-stream) (seq sequence) &key start end) ¶stream) (seq sequence) &key start end) ¶buffered-output-stream) (seq sequence) &key start end) ¶output-stream) (seq sequence) &key start end) ¶string-output-stream) &rest initargs &key element-type &allow-other-keys) ¶sequence-input-stream) &rest initargs &key sequence &allow-other-keys) ¶An error that is signalled when trying to read from or write to a closed stream.
condition.
:stream
This slot is read-only.
An error that is signalled when stream end was reached.
Superclass for all errors related to streams.
error.
:stream
This slot is read-only.
An error which is signalled when an input error occurs on a stream.
An error which is signalled when an output error occurs on a stream.
cl-stream:*stream-default-buffer-size*
:input-buffer-size
This slot is read-only.
cl-stream:fixnum+
0
cl-stream:fixnum+
0
An output stream that buffers its writes until it
gets flushed. To subclass it actual methods are needed for
MAKE-STREAM-OUTPUT-BUFFER
STREAM-WRITE-ELEMENT-TO-BUFFER
STREAM-FLUSH-OUTPUT
stream-clear-output.
stream-close.
stream-close.
stream-copy.
stream-discard-output-buffer.
stream-element-type.
stream-flush.
stream-flush-output.
(setf stream-output-buffer).
stream-output-buffer.
stream-output-buffer-size.
(setf stream-output-index).
stream-output-index.
(setf stream-output-length).
stream-output-length.
stream-write.
stream-write-sequence.
t
:element-type
cl-stream:*stream-default-buffer-size*
:output-buffer-size
This slot is read-only.
cl-stream:fixnum+
0
cl-stream:fixnum+
0
Subclass of STREAM supporting READ operations.
cl-stream:buffered-output-stream
:stream
This slot is read-only.
Subclass of STREAM supporting STREAM-WRITE operation.
make-queue-buffer.
queue-buffer.
(setf queue-buffer-size).
queue-buffer-size.
(setf queue-first).
queue-first.
queue-last.
(setf queue-length).
queue-length.
(setf queue-read-index).
queue-read-index.
(setf queue-write-index).
queue-write-index.
stream-blocking-p.
(setf stream-element-type).
stream-element-type.
stream-read.
stream-write.
cl-stream:fixnum+
cl-stream:*stream-default-buffer-size*
:buffer-size
vector
t
:type
common-lisp.
cl-stream:fixnum+
0
cl-stream:fixnum+
0
cl-stream:fixnum+
0
A buffered input stream that reads from a sequence.
boolean
t
A buffered output stream that writes to a sequence.
Base class for all streams.
| Initarg | Value |
|---|---|
:element-type | (quote character) |
cl-stream:stream
:stream
This slot is read-only.
Binds VAR to a new vector output stream with element-type ELEMENT-TYPE. Returns the output vector if BODY returns normally. The stream is closed after BODY returns normally or before it is aborted by a control transfer of some kind.
Checks if STREAM is open and signals an error otherwise.
buffered-input-stream)) ¶multi-buffered-output-stream)) ¶multi-buffered-output-stream)) ¶Returns the element in stream buffer at position.
Removes the contents of the output buffer.
super-stream)) ¶buffered-output-stream)) ¶Prevent all further operations on STREAM.
sequence-output-stream)) ¶sequence-input-stream)) ¶multi-buffered-output-stream)) ¶super-stream)) ¶stream)) ¶buffered-output-stream)) ¶buffered-output-stream)) ¶buffered-input-stream)) ¶stream)) ¶line-tracking-input-stream)) ¶automatically generated reader method
line-tracking-input-stream)) ¶automatically generated writer method
line-tracking-input-stream)) ¶automatically generated reader method
line-tracking-input-stream)) ¶automatically generated writer method
| Jump to: | (
C D F G I M Q R S W |
|---|
| Jump to: | (
C D F G I M Q R S W |
|---|
| Jump to: | *
+
B C E I L O R S U W |
|---|
| Jump to: | *
+
B C E I L O R S U W |
|---|
| Jump to: | B C E F I L M N O P Q S T U V |
|---|
| Jump to: | B C E F I L M N O P Q S T U V |
|---|