Liking cljdoc? Tell your friends :D

active.clojure.monad

Monad related functionality, particularly free monads.

Monad related functionality, particularly free monads.
raw docstring

and-finallyclj/s

(and-finally m final-m)

Execute m, and always final-m, no matter if an exception occurs or not.

Execute m, and always final-m, no matter if an exception occurs or not.
sourceraw docstring

Bindclj/s

source

bind-exceptclj/s

(bind-except m handler f)

Evaluate m, and if an exception occurs continue with (handler exception), otherwise with (f value-of-m). Note that neither the handler result is to f, nor exceptions are caught in f.

Evaluate m, and if an exception occurs continue with (handler exception), otherwise with (f value-of-m).
Note that neither the handler result is to f, nor exceptions are caught in f.
sourceraw docstring

call-ccclj/s

(call-cc f)

Construct a CallCC (Accepts a function f with one argument that returns a monadic value. call-cc packages the current continuation as a function and passes it as an argument to f. If the function is called later, the continuation of that call will be discarded and instead reinstate the continuation that was in effect when the function was created.) record.

f: access via active.clojure.monad/call-cc-f

Construct a `CallCC` (Accepts a function `f` with one argument that
  returns a monadic value.  `call-cc` packages the current continuation as a
  function and passes it as an argument to `f`.  If the function is called
  later, the continuation of that call will be discarded and instead reinstate
  the continuation that was in effect when the function was created.) record.

`f`: access via [[active.clojure.monad/call-cc-f]]
sourceraw docstring

call-cc-fclj/s≠

clj
(call-cc-f rec__2604__auto__)
(call-cc-f data__2605__auto__ v__2606__auto__)
cljs
(call-cc-f rec__2299__auto__)
(call-cc-f data__2300__auto__ v__2301__auto__)

Lens for the f field from a CallCC record. See active.clojure.monad/call-cc.

Lens for the `f` field from a [[CallCC]] record. See [[active.clojure.monad/call-cc]].
sourceraw docstring

call-cc?clj/s

(call-cc? thing)

Is object a CallCC record? See active.clojure.monad/call-cc.

Is object a `CallCC` record? See [[active.clojure.monad/call-cc]].
sourceraw docstring

CallCCclj/s≠

cljs

Accepts a function f with one argument that returns a monadic value. call-cc packages the current continuation as a function and passes it as an argument to f. If the function is called later, the continuation of that call will be discarded and instead reinstate the continuation that was in effect when the function was created.

Accepts a function `f` with one argument that
returns a monadic value.  `call-cc` packages the current continuation as a
function and passes it as an argument to `f`.  If the function is called
later, the continuation of that call will be discarded and instead reinstate
the continuation that was in effect when the function was created.
source (clj)source (cljs)raw docstring

combine-monad-command-configsclj/s

(combine-monad-command-configs & mccs)

Combine a sequence of monad-command configs into one. The earlier entries have precedence.

Combine a sequence of monad-command configs into one.
The earlier entries have precedence.
sourceraw docstring

execute-free-reader-state-exceptionclj/s

(execute-free-reader-state-exception command-config m & [state])

Run monadic computation in a reader-state-exception monad, turning exceptions into Clojure exceptions.

  • command-config is the configuration object for running commands
  • m is the computation to run
  • state is an optional initial state (from a previous run)

Returns [result state].

Run monadic computation in a reader-state-exception monad, turning exceptions
into Clojure exceptions.

- `command-config` is the configuration object for running commands
- `m` is the computation to run
- `state` is an optional initial state (from a previous run)

Returns [result state].
sourceraw docstring

execute-monadic-swiss-armyclj/s

(execute-monadic-swiss-army command-config m & [state])

Run monadic computation in an almighty monad, turning exceptions into Clojure exceptions. See [[`run-monadic-swiss-army]].

  • command-config is the configuration object for running commands
  • m is the computation to run
  • state is an optional initial state (from a previous run)

Returns [result state].

Run monadic computation in an almighty monad, turning exceptions
into Clojure exceptions.  See [[`run-monadic-swiss-army]].

- `command-config` is the configuration object for running commands
- `m` is the computation to run
- `state` is an optional initial state (from a previous run)

Returns [result state].
sourceraw docstring

free-bindclj/s

(free-bind mv f)

Bind/flatMap for the free monad.

Bind/flatMap for the free monad.
sourceraw docstring

free-bind-contclj/s≠

clj
(free-bind-cont rec__2604__auto__)
(free-bind-cont data__2605__auto__ v__2606__auto__)
cljs
(free-bind-cont rec__2299__auto__)
(free-bind-cont data__2300__auto__ v__2301__auto__)

Lens for the cont field from a Bind record. See active.clojure.monad/make-free-bind.

Lens for the `cont` field from a [[Bind]] record. See [[active.clojure.monad/make-free-bind]].
sourceraw docstring

free-bind-monadclj/s≠

clj
(free-bind-monad rec__2604__auto__)
(free-bind-monad data__2605__auto__ v__2606__auto__)
cljs
(free-bind-monad rec__2299__auto__)
(free-bind-monad data__2300__auto__ v__2301__auto__)

Lens for the monad field from a Bind record. See active.clojure.monad/make-free-bind.

Lens for the `monad` field from a [[Bind]] record. See [[active.clojure.monad/make-free-bind]].
sourceraw docstring

free-bind?clj/s

(free-bind? thing)

Is object a Bind record? See active.clojure.monad/make-free-bind.

Is object a `Bind` record? See [[active.clojure.monad/make-free-bind]].
sourceraw docstring

get-env-componentclj/s

(get-env-component name)

Retrieve a named component of a map-valued environment.

Retrieve a named component of a map-valued environment.
sourceraw docstring

get-state-componentclj/s

(get-state-component name)

Retrieve a named component of a map-valued state.

Retrieve a named component of a map-valued state.
sourceraw docstring

make-free-bindclj/s

(make-free-bind monad cont)

Construct a Bind record.

monad: access via active.clojure.monad/free-bind-monad cont: access via active.clojure.monad/free-bind-cont

Construct a `Bind` record.

`monad`: access via [[active.clojure.monad/free-bind-monad]]
`cont`: access via [[active.clojure.monad/free-bind-cont]]
sourceraw docstring

make-monad-command-configclj/s

(make-monad-command-config run-command env state)

Construct a MonadCommandConfig (Configuration for supporting a set of monad commands.) record.

run-command: access via active.clojure.monad/monad-command-config-run-command env: access via active.clojure.monad/monad-command-config-env state: access via active.clojure.monad/monad-command-config-state

Construct a `MonadCommandConfig` (Configuration for supporting a set of monad commands.) record.

`run-command`: access via [[active.clojure.monad/monad-command-config-run-command]]
`env`: access via [[active.clojure.monad/monad-command-config-env]]
`state`: access via [[active.clojure.monad/monad-command-config-state]]
sourceraw docstring

monad-command-config-envclj/s≠

clj
(monad-command-config-env rec__2604__auto__)
(monad-command-config-env data__2605__auto__ v__2606__auto__)
cljs
(monad-command-config-env rec__2299__auto__)
(monad-command-config-env data__2300__auto__ v__2301__auto__)

reader-monad initial environment represented as a mergable map

reader-monad initial environment represented as a mergable map
sourceraw docstring

monad-command-config-run-commandclj/s≠

clj
(monad-command-config-run-command rec__2604__auto__)
(monad-command-config-run-command data__2605__auto__ v__2606__auto__)
cljs
(monad-command-config-run-command rec__2299__auto__)
(monad-command-config-run-command data__2300__auto__ v__2301__auto__)

run-command :: run-any env state comp -> (| [(| exception-value? val) state] unknown-command) Where run-any is a function for running any monad command of the signature `env state comp -> (| [(| exception-value? val) state] unknown-command)

`run-command` :: run-any env state comp -> (| [(| exception-value? val) state] unknown-command)
Where `run-any` is a function for running any monad command of the signature
`env state comp -> (| [(| exception-value? val) state] unknown-command)
sourceraw docstring

monad-command-config-stateclj/s≠

clj
(monad-command-config-state rec__2604__auto__)
(monad-command-config-state data__2605__auto__ v__2606__auto__)
cljs
(monad-command-config-state rec__2299__auto__)
(monad-command-config-state data__2300__auto__ v__2301__auto__)

state-monad initial state represented as a mergable map

state-monad initial state represented as a mergable map
sourceraw docstring

monad-command-config?clj/s

(monad-command-config? thing)

Is object a MonadCommandConfig record? See active.clojure.monad/make-monad-command-config.

Is object a `MonadCommandConfig` record? See [[active.clojure.monad/make-monad-command-config]].
sourceraw docstring

MonadCommandConfigclj/s≠

cljs

Configuration for supporting a set of monad commands.

Configuration for supporting a set of monad commands.
source (clj)source (cljs)raw docstring

monadicclj/smacro

(monadic & ?stmts)

Construct a monadic computation.

The syntax is (monadic <stmt> ...) where <stmt> is one of the following:

  • [<pat> <exp> ...] which creates monadic bindings
  • (let <bindings>) which creates regular bindings
  • anything else is just a regular expression, expected to yield a monadic value.

Example:

(monadic [first (ask "what's your first name?")
          last (ask "what's your last name?")]
         (let [s (str "Hello, " first " " last)])
         (tell s))
Construct a monadic computation.

The syntax is `(monadic <stmt> ...)` where `<stmt>` is one of the following:

- `[<pat> <exp> ...]` which creates monadic bindings
- `(let <bindings>)` which creates regular bindings
- anything else is just a regular expression, expected to yield a monadic value.

Example:

    (monadic [first (ask "what's your first name?")
              last (ask "what's your last name?")]
             (let [s (str "Hello, " first " " last)])
             (tell s))
sourceraw docstring

null-monad-command-configclj/s

(null-monad-command-config env state)

Monad command-configuration with no commands except for reader/state/exception.

Monad command-configuration with no commands except for reader/state/exception.
sourceraw docstring

put-state-component!clj/s

(put-state-component! name value)

Set a named component of a map-valued state.

Set a named component of a map-valued state.
sourceraw docstring

reified?clj/s

(reified? m)

Checks whether a monadic command is reified.

Checks whether a monadic command is reified.
sourceraw docstring

reify-asclj/s

(reify-as m reification)

Adds reification meta data to m that helps utilities (like the mock runner for tests), to reify a composed command as something comparable (and printable), for cases where the command itself is not; e.g. it includes a bind inside. See [[reify-command]] to extract the meta data again.

Adds `reification` meta data to `m` that helps utilities (like the
mock runner for tests), to reify a composed command as something
comparable (and printable), for cases where the command itself is
not; e.g. it includes a `bind` inside. See [[`reify-command`]] to
extract the meta data again.
sourceraw docstring

reify-commandclj/s

(reify-command m)

Return the reification object of m, if one was added with [[reify-as]], or m itself otherwise.

Return the reification object of `m`, if one was added
with [[`reify-as`]], or m itself otherwise.
sourceraw docstring

returnclj/s

source

run-free-reader-state-exceptionclj/s

(run-free-reader-state-exception command-config m & [state])

Run monadic computation in a reader-state-exception monad.

  • command-config is the configuration object for running commands
  • m is the computation to run
  • state an optional initial state (from a previous run) that is merged into the one from command-config

Returns [result state]

Run monadic computation in a reader-state-exception monad.

- `command-config` is the configuration object for running commands
- `m` is the computation to run
- `state` an optional initial state (from a previous run) that is merged
  into the one from `command-config`

Returns [result state]
sourceraw docstring

run-monadic-swiss-armyclj/s

(run-monadic-swiss-army command-config m & [state])

Run a monadic computation in an almighty monad. Same as [[run-free-reader-state-exception]] with the addition of call-cc.

  • command-config is the configuration object for running commands
  • m is the computation to run
  • state an optional initial state (from a previous run) that is merged into the one from command-config

Returns [result state]

Run a monadic computation in an almighty monad.  Same as
[[`run-free-reader-state-exception`]] with the addition of `call-cc`.

- `command-config` is the configuration object for running commands
- `m` is the computation to run
- `state` an optional initial state (from a previous run) that is merged
  into the one from `command-config`

Returns [result state]
sourceraw docstring

run-no-commandsclj/s

(run-no-commands run-any env state m)

For use in make-monad-command-config when there are no commands.

For use in [[make-monad-command-config]] when there are no commands.
sourceraw docstring

sequclj/s

(sequ ms)

Evaluate each action in the sequence from left to right, and collect the results.

Evaluate each action in the sequence from left to right, and collect the results.
sourceraw docstring

sequ_clj/s

(sequ_ ms)

Evaluate each action in the sequence from left to right, and ignore the results.

Evaluate each action in the sequence from left to right, and ignore the results.
sourceraw docstring

throw-illegal-argument-exceptionclj/s

(throw-illegal-argument-exception msg)
source

unknown-commandclj/s

Marker that command functions can return to signal they don't recognize a command.

Marker that command functions can return to signal they don't recognize a command.
sourceraw docstring

update-state-component!clj/s

(update-state-component! name f & args)

Calls f with the current value of the component and puts back return value as the new component.

Calls f with the current value of the component and puts back return value as the new component.
sourceraw docstring

with-env-componentclj/s

(with-env-component key f m)

Transform a keyed component of a map-valued environment.

Transform a keyed component of a map-valued environment.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close