This is the lense Reference Manual, version 0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 05:35:48 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
lenseRacket style lenses for the Common Lisp.
Marek Kochanowicz
Marek Kochanowicz
BSD-2
0.0.0
alexandria (system).
documentation-utils-extensions (system).
closer-mop (system).
package.lisp (file).
macros.lisp (file).
types.lisp (file).
protocol.lisp (file).
implementation.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
lense/lense.asdlense/package.lisplense/macros.lisplense/types.lisplense/protocol.lisplense/implementation.lisplense/documentation.lisplense/macros.lisppackage.lisp (file).
lense (system).
for (macro).
lense/types.lispmacros.lisp (file).
lense (system).
basic-lense (class).
composed-lense (class).
fundamental-lense (class).
internal-lenses (reader method).
read-callback (reader method).
write-callback (reader method).
lense/protocol.lisptypes.lisp (file).
lense (system).
lense/implementation.lispprotocol.lisp (file).
lense (system).
lense/documentation.lispimplementation.lisp (file).
lense (system).
Packages are listed by definition order.
lensealexandria.
common-lisp.
access (function).
(setf access) (function).
basic-lense (class).
compose (function).
composed-lense (class).
for (macro).
fundamental-lense (class).
gather (generic function).
read (generic function).
transform (generic function).
write (generic function).
internal-lenses (generic reader).
read-callback (generic reader).
write-callback (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Description:
Macro. Expands to construction of BASIC-LENS for designated SETFable place.
Exceptional situations:
Use of this macro should include one symbol :_ in the arguments designating position in the lambda list where OBJECT should be placed. If there is either more than one such symbol in the ARGUMETS or there is none, the CL:PROGRAM-ERROR will be raised.
Description:
SETFable alternative to the READ function.
See also:
–READ
–WRITE
Description:
Stacks lenses on each other to build a COMPOSED-LENS.
Returns:
Instance of COMPOSED-LENSE.
Exceptional situations:
Every argument must be a lense supporting GATHER function.
Description:
This function gathers all elementary lenses from the input lense into the DESTINATION-VECTOR. This is required for the simplicity and efficiency of the COMPOSE function. Constructed COMPOSED-LENSE has flat internal lenses structure which eleminates pointless recursive calls that can potentially occur otherwise.
Returns:
DESTINATION-VECTOR
Exceptional situations:
Will signal CL:TYPE-ERROR (with interactive restart) if DESTINATION-VECTOR is not (AND (VECTOR T) (SATISFIES ADJUSTABLE-ARRAY-P))
composed-lense) &optional destination-vector) ¶fundamental-lense) &optional destination-vector) ¶Arguments:
–LENSE, LENS used to read the OBJECT.
–OBJECT, OBJECT that is being read.
Description:
Read trough the lens. Use the LENS to retrieve value from the OBJECT.
Returns:
Value obtained.
See also:
–ACCESS
–WRITE
Notes:
Instead of calling this function, one may funcall LENSE object directly on data.
composed-lense) object) ¶basic-lense) object) ¶Description:
READ value from the lens. FUNCALL passed transformation on the value. WRITE value back, using the same lense.
Exceptional situations:
–Will signal CL:TYPE-ERROR (with restart) if TRANSFORMATION is not a function.
Notes:
Specialization of this generic function for the COMPOSED-LENSE will not pipe object via the sublenses twice.
composed-lense) transformation object) ¶fundamental-lense) transformation object) ¶Arguments:
–LENSE, LENS used to read the OBJECT.
–VALUE, VALUE deposited into the OBJECT.
–OBJECT, OBJECT that is being read.
Description:
Write trough the lens. Use the LENS to deposit value into the OBJECT.
See also:
–ACCESS
–READ
composed-lense) value object) ¶basic-lense) value object) ¶fundamental-lense) &key &allow-other-keys) ¶Description:
Elementary lense, acts as a wrapper around an setfable place. Constructed by expansion of LENS:FOR macro.
Description:
COMPOSED-LENSE pipes all READ, WRITE and COMPOSE calls trough the lenses used to construct the result (from left to right, in the opposite order to the ALEXANDRIA:COMPOSE).
:internal-lenses
This slot is read-only.
Description:
Fundamental class of all lenses. All subclasses of this class should support following generic functions: READ, WRITE. TRANSFORM and GATHER have potentially usefull default methods (TRANSFORM simply calls READ and WRITE in a succession which may or may not be efficient, GATHER simply puts the lense into the result vector).
funcallable-standard-object.
composed-lense)) ¶automatically generated reader method
basic-lense)) ¶automatically generated reader method
basic-lense)) ¶automatically generated reader method
| Jump to: | (
A C F G I M R T W |
|---|
| Jump to: | (
A C F G I M R T W |
|---|
| Jump to: | %
S |
|---|
| Jump to: | %
S |
|---|
| Jump to: | B C D F I L M P S T |
|---|
| Jump to: | B C D F I L M P S T |
|---|