LanguageExt.Core ► Monads ► State and Environment Monads ► Reader ► ReaderT

Contents

ReaderT <Env, M, A> (Func<Env, K<M, A>> runReader)

Pure (A value)
Asks (Func<Env, A> f)
AsksM (Func<Env, K<M, A>> f)
Lift (Pure<A> monad)
Lift (K<M, A> monad)
Lift (Func<A> f)
LiftIO (IO<A> ma)
With <Env1> (Func<Env1, Env> f)
Local (Func<Env, Env> f)
MapM <M1, B> (Func<K<M, A>, K<M1, B>> f)
Map (Func<A, B> f)
Select (Func<A, B> f)
Bind (Func<A, K<ReaderT<Env, M>, B>> f)
Bind (Func<A, ReaderT<Env, M, B>> f)
Bind (Func<A, Ask<Env, B>> f)
Bind (Func<A, IO> f)
SelectMany <B, C> (Func<A, K<ReaderT<Env, M>, B>> bind, Func<A, B, C> project)
SelectMany <B, C> (Func<A, ReaderT<Env, M, B>> bind, Func<A, B, C> project)
SelectMany <B, C> (Func<A, K<M, B>> bind, Func<A, B, C> project)
SelectMany <B, C> (Func<A, Pure> bind, Func<A, B, C> project)
SelectMany <B, C> (Func<A, Ask<Env, B>> bind, Func<A, B, C> project)
SelectMany <B, C> (Func<A, IO> bind, Func<A, B, C> project)
Run (Env env)

ReaderT <Env>

lift <M, A> (K<M, A> ma)

ReaderT <Env, M>

pure <A> (A value)
liftIO <A> (IO<A> effect)

ReaderT

pure <Env, M, A> (A value)
lift <Env, M, A> (K<M, A> ma)
liftIO <Env, M, A> (IO<A> effect)
ask <M, Env> ()
asks <M, A, Env> (Func<Env, A> f)
asksM <M, Env, A> (Func<Env, K<M, A>> f)
local <Env, M, A> (Func<Env, Env> f, ReaderT<Env, M, A> ma)
with <Env, SubEnv, M, A> (Func<Env, SubEnv> f, ReaderT<SubEnv, M, A> ma)

Sub modules

record ReaderT <Env, M, A> (Func<Env, K<M, A>> runReader) Source #

where M : Monad<M>

ReaderT monad transformer, which adds a static environment to a given monad.

Parameters

type	Env	Reader environment type
type	M	Given monad trait
type	A	Bound value type

Methods

method ReaderT<Env, M, A> Pure (A value) Source #

Lift a pure value into the monad-transformer

Parameters

param	value	Value to lift
returns	`ReaderT`

method ReaderT<Env, M, A> Asks (Func<Env, A> f) Source #

Extracts the environment value and maps it to the bound value

Parameters

param	f	Environment mapping function
returns	`ReaderT`

method ReaderT<Env, M, A> AsksM (Func<Env, K<M, A>> f) Source #

Extracts the environment value and maps it to the bound value

Parameters

param	f	Environment mapping function
returns	`ReaderT`

method ReaderT<Env, M, A> Lift (Pure<A> monad) Source #

Lifts a given monad into the transformer

Parameters

param	monad	Monad to lift
returns	`ReaderT`

method ReaderT<Env, M, A> Lift (K<M, A> monad) Source #

Lifts a given monad into the transformer

Parameters

param	monad	Monad to lift
returns	`ReaderT`

method ReaderT<Env, M, A> Lift (Func<A> f) Source #

Lifts a unit function into the transformer

Parameters

param	f	Function to lift
returns	`ReaderT`

method ReaderT<Env, M, A> LiftIO (IO<A> ma) Source #

Lifts a unit function into the transformer

Parameters

param	f	Function to lift
returns	`ReaderT`

method ReaderT<Env1, M, A> With <Env1> (Func<Env1, Env> f) Source #

Maps the Reader's environment value

Parameters

param	f	Mapping function
returns	`ReaderT`

method ReaderT<Env, M, A> Local (Func<Env, Env> f) Source #

Maps the Reader's environment value

Parameters

param	f	Mapping function
returns	`ReaderT`

method ReaderT<Env, M1, B> MapM <M1, B> (Func<K<M, A>, K<M1, B>> f) Source #

where M1 : Monad<M1>, Alternative<M1>

Maps the given monad

Parameters

type	M1	Trait of the monad to map to
param	f	Mapping function
returns	`ReaderT`

method ReaderT<Env, M, B> Map (Func<A, B> f) Source #

Maps the bound value

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`ReaderT`

method ReaderT<Env, M, B> Select (Func<A, B> f) Source #

Maps the bound value

Parameters

type	B	Target bound value type
param	f	Mapping transducer
returns	`ReaderT`

method ReaderT<Env, M, B> Bind (Func<A, K<ReaderT<Env, M>, B>> f) Source #

Monad bind operation

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`ReaderT`

method ReaderT<Env, M, B> Bind (Func<A, ReaderT<Env, M, B>> f) Source #

Monad bind operation

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`ReaderT`

method ReaderT<Env, M, B> Bind (Func<A, Ask<Env, B>> f) Source #

Monad bind operation

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`ReaderT`

method ReaderT<Env, M, B> Bind (Func<A, IO> f) Source #

Monad bind operation

Parameters

type	B	Target bound value type
param	f	Mapping function
returns	`ReaderT`

method ReaderT<Env, M, C> SelectMany <B, C> (Func<A, K<ReaderT<Env, M>, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`ReaderT`

method ReaderT<Env, M, C> SelectMany <B, C> (Func<A, ReaderT<Env, M, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`ReaderT`

method ReaderT<Env, M, C> SelectMany <B, C> (Func<A, K<M, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`ReaderT`

method ReaderT<Env, M, C> SelectMany <B, C> (Func<A, Pure> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`ReaderT`

method ReaderT<Env, M, C> SelectMany <B, C> (Func<A, Ask<Env, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`ReaderT`

method ReaderT<Env, M, C> SelectMany <B, C> (Func<A, IO> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type	B	Intermediate bound value type
type	C	Target bound value type
param	bind	Monadic bind function
param	project	Projection function
returns	`ReaderT`

method K<M, A> Run (Env env) Source #

Run the reader monad

Parameters

param	env	Input environment
returns	Bound monad

class ReaderT <Env> Source #

MonadReaderT trait implementation for ReaderT

Parameters

type	Env	Reader environment type
type	M	Given monad trait

Methods

method ReaderT<Env, M, A> lift <M, A> (K<M, A> ma) Source #

where M : Monad<M>

class ReaderT <Env, M> Source #

Methods

method ReaderT<Env, M, A> pure <A> (A value) Source #

method ReaderT<Env, M, A> liftIO <A> (IO<A> effect) Source #

Lifts a given monad into the transformer

Parameters

param	effect	Monad to lift
returns	`ReaderT`

class ReaderT Source #

MonadReaderT trait implementation for ReaderT

Parameters

type	Env	Reader environment type
type	M	Given monad trait

Methods

method ReaderT<Env, M, A> pure <Env, M, A> (A value) Source #

where M : Monad<M>

method ReaderT<Env, M, A> lift <Env, M, A> (K<M, A> ma) Source #

where M : Monad<M>

method ReaderT<Env, M, A> liftIO <Env, M, A> (IO<A> effect) Source #

where M : Monad<M>

Lifts a given monad into the transformer

Parameters

param	effect	Monad to lift
returns	`ReaderT`

method ReaderT<Env, M, Env> ask <M, Env> () Source #

where M : Monad<M>

method ReaderT<Env, M, A> asks <M, A, Env> (Func<Env, A> f) Source #

where M : Monad<M>

method ReaderT<Env, M, A> asksM <M, Env, A> (Func<Env, K<M, A>> f) Source #

where M : Monad<M>

method ReaderT<Env, M, A> local <Env, M, A> (Func<Env, Env> f, ReaderT<Env, M, A> ma) Source #

where M : Monad<M>

method ReaderT<Env, M, A> with <Env, SubEnv, M, A> (Func<Env, SubEnv> f, ReaderT<SubEnv, M, A> ma) Source #

where M : Monad<M>