This is the rail Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:36:34 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
railLibrary implementing functions for railway oriented programming.
Marcin Radoszewski
MIT
0.0.1
package.lisp (file).
rail.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
rail/rail.lisppackage.lisp (file).
rail (system).
bind (function).
branch-messages (reader method).
(setf branch-messages) (writer method).
branch-name (reader method).
(setf branch-name) (writer method).
branch-value (reader method).
(setf branch-value) (writer method).
either (generic function).
fail (function).
fail-if-nil (function).
fail? (function).
failure (class).
failure-side-effect (generic function).
failure-tee (function).
fapply (generic function).
flat-map (function).
fmap (function).
get-or-default (generic function).
get-or-default-f (generic function).
lift (function).
map-messages (function).
map-success (function).
merge-messages (function).
print-object (method).
print-object (method).
succeed (function).
success (class).
success-side-effect (generic function).
success-tee (function).
success? (function).
branch (class).
branch-copy (generic function).
Packages are listed by definition order.
railcommon-lisp.
bind (function).
branch-messages (generic reader).
(setf branch-messages) (generic writer).
branch-name (generic reader).
(setf branch-name) (generic writer).
branch-value (generic reader).
(setf branch-value) (generic writer).
either (generic function).
fail (function).
fail-if-nil (function).
fail? (function).
failure (class).
failure-side-effect (generic function).
failure-tee (function).
fapply (generic function).
flat-map (function).
fmap (function).
get-or-default (generic function).
get-or-default-f (generic function).
lift (function).
map-messages (function).
map-success (function).
merge-messages (function).
succeed (function).
success (class).
success-side-effect (generic function).
success-tee (function).
success? (function).
branch (class).
branch-copy (generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Given function f (value -> branch) applies it on success branch
Creates branch from a value. If value is nil then fails with given message
Given a function f : applies it to value stored in branch
Given a function (f : (messages) -> messages) applies function to branch messages
Given a function (f : (value messages) -> branch) transforms success branch and returns a resulting branch
Merges additional messages to the branch
Create a success branch. Optionally with messages.
Applies f-success if on success branch of f-failure if on failure branch. f-success takes value and a list of messages and should return a branch. f-failure takes list of messages and returns a branch.
Given a function f : (messages) -> any and a branch
applies the function to the success branch and returns result unchanged
Applies function (value -> value) stored as a value in f-branch to value stored in v-branch.
Returns the value from success branch or default for failure branch.
Returns the value from success branch or computed value from default-f function for failure
Given a function f : (value, messages) -> any and a branch
applies the function to the success branch and returns result unchanged
Copies given branch and gives the ability to update it’s contents
| Jump to: | (
B E F G L M P S |
|---|
| Jump to: | (
B E F G L M P S |
|---|
| Jump to: | M N S V |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| M | |||
messages: | Private classes | ||
| | |||
| N | |||
name: | Public classes | ||
name: | Public classes | ||
name: | Private classes | ||
| | |||
| S | |||
Slot, messages: | Private classes | ||
Slot, name: | Public classes | ||
Slot, name: | Public classes | ||
Slot, name: | Private classes | ||
Slot, value: | Public classes | ||
| | |||
| V | |||
value: | Public classes | ||
| | |||
| Jump to: | M N S V |
|---|
| Jump to: | B C F P R S |
|---|
| Jump to: | B C F P R S |
|---|