This is the com.clearly-useful.iterator-protocol Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 04:47:13 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
com.clearly-useful.iterator-protocolA simple iterator protocol for Common Lisp.
Jason Aeschliman <j.aeschliman@gmail.com>
revised BSD
0.1
com.clearly-useful.protocols (system).
com.clearly-useful.generic-collection-interface (system).
package.lisp (file).
com.clearly-useful.iterator-protocol.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
com.clearly-useful.iterator-protocol/com.clearly-useful.iterator-protocol.asdcom.clearly-useful.iterator-protocol/package.lispcom.clearly-useful.iterator-protocol/com.clearly-useful.iterator-protocol.lispcom.clearly-useful.iterator-protocol/com.clearly-useful.iterator-protocol.asdcom.clearly-useful.iterator-protocol (system).
com.clearly-useful.iterator-protocol/package.lispcom.clearly-useful.iterator-protocol (system).
com.clearly-useful.iterator-protocol/com.clearly-useful.iterator-protocol.lisppackage.lisp (file).
com.clearly-useful.iterator-protocol (system).
do-iterator (macro).
iterator (generic function).
iterator (type).
iterator-finish! (generic function).
iterator-next! (generic function).
iterator-p (function).
%advance (function).
%has-value (function).
%indexable-iterator (structure).
%indexable-iterator-idx (reader).
(setf %indexable-iterator-idx) (writer).
%indexable-iterator-p (function).
%indexable-iterator-pos (reader).
(setf %indexable-iterator-pos) (writer).
%indexable-iterator-size (reader).
(setf %indexable-iterator-size) (writer).
%seq-iterator (structure).
%seq-iterator-p (function).
%seq-iterator-seq (reader).
(setf %seq-iterator-seq) (writer).
%value (function).
%vector-iterator (structure).
%vector-iterator-p (function).
%vector-iterator-pos (reader).
(setf %vector-iterator-pos) (writer).
%vector-iterator-size (reader).
(setf %vector-iterator-size) (writer).
%vector-iterator-vec (reader).
(setf %vector-iterator-vec) (writer).
copy-%indexable-iterator (function).
copy-%seq-iterator (function).
copy-%vector-iterator (function).
implements-protocol? (method).
implements-protocol? (method).
implements-protocol? (method).
make-%indexable-iterator (function).
make-%seq-iterator (function).
make-%vector-iterator (function).
Packages are listed by definition order.
com.clearly-useful.iterator-protocolcom.clearly-useful.generic-collection-interface.
com.clearly-useful.protocols.
common-lisp.
do-iterator (macro).
iterator (generic function).
iterator (type).
iterator-finish! (generic function).
iterator-next! (generic function).
iterator-p (function).
%advance (function).
%has-value (function).
%indexable-iterator (structure).
%indexable-iterator-idx (reader).
(setf %indexable-iterator-idx) (writer).
%indexable-iterator-p (function).
%indexable-iterator-pos (reader).
(setf %indexable-iterator-pos) (writer).
%indexable-iterator-size (reader).
(setf %indexable-iterator-size) (writer).
%seq-iterator (structure).
%seq-iterator-p (function).
%seq-iterator-seq (reader).
(setf %seq-iterator-seq) (writer).
%value (function).
%vector-iterator (structure).
%vector-iterator-p (function).
%vector-iterator-pos (reader).
(setf %vector-iterator-pos) (writer).
%vector-iterator-size (reader).
(setf %vector-iterator-size) (writer).
%vector-iterator-vec (reader).
(setf %vector-iterator-vec) (writer).
copy-%indexable-iterator (function).
copy-%seq-iterator (function).
copy-%vector-iterator (function).
make-%indexable-iterator (function).
make-%seq-iterator (function).
make-%vector-iterator (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
convert an object to ITERATOR protocol, or error.
hash-table)) ¶array)) ¶vector)) ¶%indexable-iterator)) ¶%vector-iterator)) ¶%seq-iterator)) ¶performs ’clean up’ operations specific to the iterator. e.g. closing a file.
%indexable-iterator)) ¶%vector-iterator)) ¶%seq-iterator)) ¶returns two values:
1. the next value of the iterator or nil,
2. t or nil depending depending whether a value was found.
then advances the iterator.
%indexable-iterator)) ¶%vector-iterator)) ¶%seq-iterator)) ¶A simple iteration protocol for Common Lisp.
Unlike sequences, iterators are stateful, and are
not intended to be held onto or passed around. Their
use should be hidden by some other construct. If you
are explicitly creating and advancing an iterator,
chances are you are Doing It Wrong.
Iterators should be be treated as though they
have dynamic extent.
idx.
pos.
size.
seq.
pos.
size.
vec.
%seq-iterator) (protocol (eql #<com.clearly-useful.protocols::protocol {100a0c2d03}>))) ¶com.clearly-useful.protocols.
%indexable-iterator) (protocol (eql #<com.clearly-useful.protocols::protocol {100a0c2d03}>))) ¶com.clearly-useful.protocols.
%vector-iterator) (protocol (eql #<com.clearly-useful.protocols::protocol {100a0c2d03}>))) ¶com.clearly-useful.protocols.
structure-object.
com.clearly-useful.generic-collection-interface.
| Jump to: | %
(
C D F G I M |
|---|
| Jump to: | %
(
C D F G I M |
|---|
| Jump to: | I P S V |
|---|
| Jump to: | I P S V |
|---|
| Jump to: | %
C F I P S T |
|---|
| Jump to: | %
C F I P S T |
|---|