LanguageExt.Core + ► +Monads + ► +State and Environment Monads + ► +RWS + ► +RWST
Contents
+- RWST +<R, W, S, M, A> +(Func<(R Env, W Output, S State), K<M, (A Value, W Output, S State)>> runRWST)
+
- Run + +(R env, W output, S state)
+
- Run + +(R env, S state)
+
- Pure + +(A value)
+
- Lift + +(K<M, A> ma)
+
- Lift + +(Pure<A> ma)
+
- LiftIO + +(K<IO, A> ma)
+
- Asks + +(Func<R, A> f)
+
- AsksM + +(Func<R, K<M, A>> f)
+
- With +<R1> +(Func<R1, R> f)
+
- Local + +(Func<R, R> f)
+
- Write + +((A Value, W Output) result)
+
- Write + +(A value, W output)
+
- Listen
+
- Listens +<B> +(Func<W, B> f)
+
- Censor + +(Func<W, W> f)
+
- Modify + +(Func<S, S> f)
+
- ModifyM + +(Func<S, K<M, S>> f)
+
- Put + +(S value)
+
- State + +(A value, S state)
+
- State + +((A Value, S State) ma)
+
- Get
+
- Gets + +(Func<S, A> f)
+
- GetsM + +(Func<S, K<M, A>> f)
- RWSTExtensions +
+
- As +<R, W, S, M, A> +(this K<RWST<R, W, S, M>, A> ma)
+
- Run +<R, W, S, M, A> +( + this K<RWST<R, W, S, M>, A> ma, R env, W output, S state)
+
- Run +<R, W, S, M, A> +( + this K<RWST<R, W, S, M>, A> ma, R env, S state)
- RWST +
+
- pure +<R, W, S, M, A> +(A value)
+
- lift +<R, W, S, M, A> +(K<M, A> ma)
+
- liftIO +<R, W, S, M, A> +(IO<A> effect)
+
- combine +<R, W, S, M, A> +( + K<RWST<R, W, S, M>, A> ma, + K<RWST<R, W, S, M>, A> mb)
+
- ask +<R, W, S, M> +()
+
- asks +<R, W, S, M, A> +(Func<R, A> f)
+
- asksM +<R, W, S, M, A> +(Func<R, K<M, A>> f)
+
- asksM +<R, W, S, M, A> +(Func<R, K<RWST<R, W, S, M>, A>> f)
+
- local +<R, W, S, M, A> +(Func<R, R> f, K<RWST<R, W, S, M>, A> ma)
+
- with +<R, R1, W, S, M, A> +(Func<R, R1> f, K<RWST<R1, W, S, M>, A> ma)
+
- tell +<R, W, S, M> +(W item)
+
- write +<R, W, S, M, A> +((A, W) item)
+
- write +<R, W, S, M, A> +(A value, W item)
+
- pass +<R, W, S, M, A> +(RWST<R, W, S, M, (A Value, Func<W, W> Function)> action)
+
- listen +<R, W, S, M, A> +(RWST<R, W, S, M, A> ma)
+
- listens +<R, W, S, M, A, B> +(Func<W, B> f, RWST<R, W, S, M, A> ma)
+
- censor +<R, W, S, M, A> +(Func<W, W> f, RWST<R, W, S, M, A> ma)
+
- get +<R, W, S, M> +()
+
- gets +<R, W, S, M, A> +(Func<S, A> f)
+
- getsM +<R, W, S, M, A> +(Func<S, K<M, A>> f)
+
- getsM +<R, W, S, M, A> +(Func<S, K<RWST<R, W, S, M>, A>> f)
+
- put +<R, W, S, M> +(S state)
+
- modify +<R, W, S, M> +(Func<S, S> f)
+
- modifyM +<R, W, S, M> +(Func<S, K<M, S>> f)
+
- modifyM +<R, W, S, M> +(Func<S, K<RWST<R, W, S, M>, S>> f)
- RWST +<R, W, S, M>
+
record +RWST +<R, W, S, M, A> +(Func<(R Env, W Output, S State), K<M, (A Value, W Output, S State)>> runRWST) +Source +# +
Reader / Write / State monad-transformer
+Parameters
+| type | +R | +Reader environment type + |
| type | +W | +Writer output type + |
| type | +S | +State type + |
| type | +M | +Lifted monad type + |
| type | +A | +Bound value type + |
Properties
+ +Methods
+method +K<M, (A Value, W Output, S State)> +Run + +(R env, W output, S state) +Source +# +
+method +K<M, (A Value, W Output, S State)> +Run + +(R env, S state) +Source +# +
+method +RWST<R, W, S, M, A> +Asks + +(Func<R, A> f) +Source +# +
+Extracts the environment value and maps it to the bound value
+Parameters
+| param | +f | +Environment mapping function + |
| returns | +
| |
method +RWST<R, W, S, M, A> +AsksM + +(Func<R, K<M, A>> f) +Source +# +
+Extracts the environment value and maps it to the bound value
+Parameters
+| param | +f | +Environment mapping function + |
| returns | +
| |
method +RWST<R1, W, S, M, A> +With +<R1> +(Func<R1, R> f) +Source +# +
+Maps the Reader's environment value
+Parameters
+| param | +f | +Mapping function + |
| returns | +
| |
method +RWST<R, W, S, M, A> +Local + +(Func<R, R> f) +Source +# +
+Maps the Reader's environment value
+Parameters
+| param | +f | +Mapping function + |
| returns | +
| |
method +RWST<R, W, S, M, A> +Write + +((A Value, W Output) result) +Source +# +
+Construct a writer computation from a (result, output) pair.
+The inverse of Run()
Parameters
+| param | +result | +Result / Output pair + |
method +RWST<R, W, S, M, A> +Write + +(A value, W output) +Source +# +
+Construct a writer computation from a (result, output) pair.
+The inverse of Run()
Parameters
+| param | +result | +Result / Output pair + |
method +RWST<R, W, S, M, (A Value, B Output)> +Listens +<B> +(Func<W, B> f) +Source +# +
+Listens executes the action and adds the result of applying f to the
+output to the value of the computation.
method +RWST<R, W, S, M, A> +Censor + +(Func<W, W> f) +Source +# +
+Censor executes the action and applies the function f to its output,
+leaving the return value unchanged.
method +RWST<R, W, S, M, Unit> +Modify + +(Func<S, S> f) +Source +# +
+Extracts the state value, maps it, and then puts it back into +the monadic state.
+Parameters
+| param | +f | +State mapping function + |
| returns | +
| |
method +RWST<R, W, S, M, Unit> +ModifyM + +(Func<S, K<M, S>> f) +Source +# +
+Extracts the state value, maps it, and then puts it back into +the monadic state.
+Parameters
+| param | +f | +State mapping function + |
| returns | +
| |
method +RWST<R, W, S, M, Unit> +Put + +(S value) +Source +# +
+Writes the value into the monadic state
+Parameters
+| returns | +
| |
method +RWST<R, W, S, M, A> +State + +(A value, S state) +Source +# +
+Writes a value and state into the monad
+Parameters
+| returns | +
| |
method +RWST<R, W, S, M, A> +State + +((A Value, S State) ma) +Source +# +
+Writes a value and state into the monad
+Parameters
+| returns | +
| |
class +RWSTExtensions + +Source +# +
+Methods
+method +RWST<R, W, S, M, A> +As +<R, W, S, M, A> +(this K<RWST<R, W, S, M>, A> ma) +Source +# +
Methods
+method +RWST<R, W, S, M, A> +pure +<R, W, S, M, A> +(A value) +Source +# +
method +RWST<R, W, S, M, A> +lift +<R, W, S, M, A> +(K<M, A> ma) +Source +# +
method +RWST<R, W, S, M, A> +liftIO +<R, W, S, M, A> +(IO<A> effect) +Source +# +
Lifts a given monad into the transformer
+Parameters
+| param | +effect | +Monad to lift + |
| returns | +
| |
method +RWST<R, W, S, M, A> +combine +<R, W, S, M, A> +( + K<RWST<R, W, S, M>, A> ma, + K<RWST<R, W, S, M>, A> mb) +Source +# +
method +RWST<R, W, S, M, R> +ask +<R, W, S, M> +() +Source +# +
method +RWST<R, W, S, M, A> +asks +<R, W, S, M, A> +(Func<R, A> f) +Source +# +
method +RWST<R, W, S, M, A> +asksM +<R, W, S, M, A> +(Func<R, K<M, A>> f) +Source +# +
method +RWST<R, W, S, M, A> +asksM +<R, W, S, M, A> +(Func<R, K<RWST<R, W, S, M>, A>> f) +Source +# +
method +RWST<R, W, S, M, A> +local +<R, W, S, M, A> +(Func<R, R> f, K<RWST<R, W, S, M>, A> ma) +Source +# +
method +RWST<R, W, S, M, A> +with +<R, R1, W, S, M, A> +(Func<R, R1> f, K<RWST<R1, W, S, M>, A> ma) +Source +# +
method +RWST<R, W, S, M, Unit> +tell +<R, W, S, M> +(W item) +Source +# +
Tell is an action that produces the writer output
+Parameters
+| type | +W | +Writer type + |
| param | +item | +Item to tell + |
| returns | +Structure with the told item + | |
method +RWST<R, W, S, M, A> +write +<R, W, S, M, A> +((A, W) item) +Source +# +
Writes an item and returns a value at the same time
+method +RWST<R, W, S, M, A> +write +<R, W, S, M, A> +(A value, W item) +Source +# +
Writes an item and returns a value at the same time
+method +RWST<R, W, S, M, A> +pass +<R, W, S, M, A> +(RWST<R, W, S, M, (A Value, Func<W, W> Function)> action) +Source +# +
pass is an action that executes the action, which returns a value and a
+function; it then returns the value with the output having been applied to
+the function.
method +RWST<R, W, S, M, (A Value, W Output)> +listen +<R, W, S, M, A> +(RWST<R, W, S, M, A> ma) +Source +# +
listen executes the action ma and adds the result of applying f to the
+output to the value of the computation.
method +RWST<R, W, S, M, (A Value, B Output)> +listens +<R, W, S, M, A, B> +(Func<W, B> f, RWST<R, W, S, M, A> ma) +Source +# +
listens executes the action ma and adds the result of applying f to the
+output to the value of the computation.
method +RWST<R, W, S, M, A> +censor +<R, W, S, M, A> +(Func<W, W> f, RWST<R, W, S, M, A> ma) +Source +# +
censor executes the action ma and applies the function f to its output,
+leaving the return value unchanged.
method +RWST<R, W, S, M, S> +get +<R, W, S, M> +() +Source +# +
method +RWST<R, W, S, M, A> +gets +<R, W, S, M, A> +(Func<S, A> f) +Source +# +
method +RWST<R, W, S, M, A> +getsM +<R, W, S, M, A> +(Func<S, K<M, A>> f) +Source +# +
method +RWST<R, W, S, M, A> +getsM +<R, W, S, M, A> +(Func<S, K<RWST<R, W, S, M>, A>> f) +Source +# +
method +RWST<R, W, S, M, Unit> +put +<R, W, S, M> +(S state) +Source +# +
method +RWST<R, W, S, M, Unit> +modify +<R, W, S, M> +(Func<S, S> f) +Source +# +
class +RWST +<R, W, S, M> +Source +# +
Reader / Write / State monad-transformer trait implementations
+Parameters
+| type | +R | +Reader environment type + |
| type | +W | +Writer output type + |
| type | +S | +State type + |
| type | +M | +Lifted monad type + |