FSharpPlus

ReaderT<'r, 'monad<'t>> Type

Namespace: FSharpPlus.Data
Assembly: FSharpPlus.dll
Base Type: ValueType
Kind: Struct

Monad Transformer for Reader<'R, 'T>

Table of contents

Functor

Static members

Static member Description

f <!> x

Full Usage: f <!> x

Parameters:
    f : 'T -> 'U
    x : ReaderT<'R, ^Monad<'T>>

Returns: ReaderT<'R, ^Monad<'U>>
Modifiers: inline
Type parameters: 'R, ^Monad<'T>, ^Monad<'U>

Lifts a function into a ReaderT. Same as map. To be used in Applicative Style expressions, combined with <*>

f : 'T -> 'U
x : ReaderT<'R, ^Monad<'T>>
Returns: ReaderT<'R, ^Monad<'U>>

Applicative

Static members

Static member Description

x *> y

Full Usage: x *> y

Parameters:
Returns: ReaderT<'R, ^Monad<'U>>
Modifiers: inline
Type parameters: ^Monad<'U->'U>, 'T, 'U, ^Monad<'U>

Sequences two Readers left-to-right, discarding the value of the first argument.

x : ReaderT<'R, ^Monad<'T>>
y : ReaderT<'R, ^Monad<'U>>
Returns: ReaderT<'R, ^Monad<'U>>

x <* y

Full Usage: x <* y

Parameters:
Returns: ReaderT<'R, ^Monad<'U>>
Modifiers: inline
Type parameters: ^Monad<'T->'U>, 'U, 'T, ^Monad<'T>

Sequences two Readers left-to-right, discarding the value of the second argument.

x : ReaderT<'R, ^Monad<'U>>
y : ReaderT<'R, ^Monad<'T>>
Returns: ReaderT<'R, ^Monad<'U>>

Monad

Static members

Static member Description

f >=> g

Full Usage: f >=> g

Parameters:
Returns: 'T -> ReaderT<'R, ^Monad<'V>>
Modifiers: inline
Type parameters: ^Monad<'U>, ^Monad<'V>, 'U

Composes left-to-right two Reader functions (Kleisli composition).

f : 'T -> ReaderT<'R, ^Monad<'U>>
g : 'U -> ReaderT<'R, ^Monad<'V>>
Returns: 'T -> ReaderT<'R, ^Monad<'V>>

f >=> g

Full Usage: f >=> g

Parameters:
Returns: 'T -> Reader<'R, 'V>

Composes left-to-right two Reader functions (Kleisli composition).

f : 'T -> Reader<'R, 'U>
g : 'U -> Reader<'R, 'V>
Returns: 'T -> Reader<'R, 'V>

x >>= f

Full Usage: x >>= f

Parameters:
Returns: ReaderT<'R, ^Monad<'U>>
Modifiers: inline
Type parameters: ^Monad<'U>, 'T

Takes a Reader value and a function from a plain type to a Reader value, and returns a new Reader value.

x : ReaderT<'R, ^Monad<'T>>
f : 'T -> ReaderT<'R, ^Monad<'U>>
Returns: ReaderT<'R, ^Monad<'U>>

Other module members

Union cases

Union case Description

ReaderT 'r -> 'monad<'t>

Full Usage: ReaderT 'r -> 'monad<'t>

Parameters:
    Item : 'r -> 'monad<'t>

Item : 'r -> 'monad<'t>

Static members

Static member Description

f <*> x

Full Usage: f <*> x

Parameters:
Returns: ReaderT<'R, ^Monad<'U>>
Modifiers: inline
Type parameters: ^Monad<'T>, ^Monad<'U>

f : ReaderT<'R, ^Monad<'T->'U>>
x : ReaderT<'R, ^Monad<'T>>
Returns: ReaderT<'R, ^Monad<'U>>

arg0 <|> arg1

Full Usage: arg0 <|> arg1

Parameters:
    arg0 : ReaderT<'R, ^MonadPlus<'T>>
    arg1 : ReaderT<'R, ^MonadPlus<'T>>

Returns: ReaderT<'R, ^MonadPlus<'T>>
Modifiers: inline

arg0 : ReaderT<'R, ^MonadPlus<'T>>
arg1 : ReaderT<'R, ^MonadPlus<'T>>
Returns: ReaderT<'R, ^MonadPlus<'T>>

ReaderT.CallCC(f)

Full Usage: ReaderT.CallCC(f)

Parameters:
    f : ('T -> ReaderT<'R, 'MonadCont<'C,'U>>) -> ReaderT<'R, ^MonadCont<'C,'T>>

Returns: ReaderT<'R, ^MonadCont<'C,'T>>
Modifiers: inline
Type parameters: 'MonadCont<'C,'U>, ^MonadCont<'C,'T>

f : ('T -> ReaderT<'R, 'MonadCont<'C,'U>>) -> ReaderT<'R, ^MonadCont<'C,'T>>
Returns: ReaderT<'R, ^MonadCont<'C,'T>>

ReaderT.Catch(m, h)

Full Usage: ReaderT.Catch(m, h)

Parameters:
    m : ReaderT<'R, ^MonadError<'E1,'T>>
    h : 'E1 -> ReaderT<'R, ^MonadError<'E2,'T>>

Returns: ReaderT<'R, ^MonadError<'E2,'T>>
Modifiers: inline
Type parameters: ^MonadError<'E2,'T>, 'E1

m : ReaderT<'R, ^MonadError<'E1,'T>>
h : 'E1 -> ReaderT<'R, ^MonadError<'E2,'T>>
Returns: ReaderT<'R, ^MonadError<'E2,'T>>

ReaderT.Delay(body)

Full Usage: ReaderT.Delay(body)

Parameters:
    body : unit -> ReaderT<'R, ^Monad<'T>>

Returns: ReaderT<'R, ^Monad<'T>>
Modifiers: inline

body : unit -> ReaderT<'R, ^Monad<'T>>
Returns: ReaderT<'R, ^Monad<'T>>

ReaderT.Lift(m)

Full Usage: ReaderT.Lift(m)

Parameters:
    m : 'Monad<'T>

Returns: ReaderT<'R, 'Monad<'T>>

m : 'Monad<'T>
Returns: ReaderT<'R, 'Monad<'T>>

ReaderT.Lift2(f, x, y)

Full Usage: ReaderT.Lift2(f, x, y)

Parameters:
    f : 'T -> 'U -> 'V
    x : ReaderT<'R, ^Monad<'T>>
    y : ReaderT<'R, ^Monad<'U>>

Returns: ReaderT<'R, ^Monad<'V>>
Modifiers: inline
Type parameters: 'V, 'R, ^Monad<'T>, ^Monad<'U>, ^Monad<'V>

f : 'T -> 'U -> 'V
x : ReaderT<'R, ^Monad<'T>>
y : ReaderT<'R, ^Monad<'U>>
Returns: ReaderT<'R, ^Monad<'V>>

ReaderT.Lift3(f, x, y, z)

Full Usage: ReaderT.Lift3(f, x, y, z)

Parameters:
    f : 'T -> 'U -> 'V -> 'W
    x : ReaderT<'R, ^Monad<'T>>
    y : ReaderT<'R, ^Monad<'U>>
    z : ReaderT<'R, ^Monad<'V>>

Returns: ReaderT<'R, ^Monad<'W>>
Modifiers: inline
Type parameters: 'V, 'W, 'R, ^Monad<'T>, ^Monad<'U>, ^Monad<'V>, ^Monad<'W>

f : 'T -> 'U -> 'V -> 'W
x : ReaderT<'R, ^Monad<'T>>
y : ReaderT<'R, ^Monad<'U>>
z : ReaderT<'R, ^Monad<'V>>
Returns: ReaderT<'R, ^Monad<'W>>

ReaderT.LiftAsync(x)

Full Usage: ReaderT.LiftAsync(x)

Parameters:
Returns: ReaderT<'R, ^MonadAsync<'T>>
Modifiers: inline
Type parameters: ^MonadAsync<'T>

x : Async<'T>
Returns: ReaderT<'R, ^MonadAsync<'T>>

ReaderT.Listen(arg1)

Full Usage: ReaderT.Listen(arg1)

Parameters:
Returns: ReaderT<'R, ^MonadWriter<'Monoid,'T*'Monoid>>
Modifiers: inline
Type parameters: ^MonadWriter<'Monoid,'T*'Monoid>

arg0 : ReaderT<'R, 'a>
Returns: ReaderT<'R, ^MonadWriter<'Monoid,'T*'Monoid>>

ReaderT.Local(arg1, f)

Full Usage: ReaderT.Local(arg1, f)

Parameters:
    arg0 : ReaderT<'R2, 'Monad<'T>>
    f : 'R1 -> 'R2

Returns: ReaderT<'R1, 'Monad<'T>>

arg0 : ReaderT<'R2, 'Monad<'T>>
f : 'R1 -> 'R2
Returns: ReaderT<'R1, 'Monad<'T>>

ReaderT.Map(x, f)

Full Usage: ReaderT.Map(x, f)

Parameters:
    x : ReaderT<'R, ^Monad<'T>>
    f : 'T -> 'U

Returns: ReaderT<'R, ^Monad<'U>>
Modifiers: inline
Type parameters: ^Monad<'U>, 'T, 'U

x : ReaderT<'R, ^Monad<'T>>
f : 'T -> 'U
Returns: ReaderT<'R, ^Monad<'U>>

ReaderT.Pass(arg1)

Full Usage: ReaderT.Pass(arg1)

Parameters:
Returns: ReaderT<'R, ^MonadWriter<'Monoid,'T>>
Modifiers: inline
Type parameters: ^MonadWriter<'Monoid,'T>

arg0 : ReaderT<'R, 'a>
Returns: ReaderT<'R, ^MonadWriter<'Monoid,'T>>

ReaderT.Put(x)

Full Usage: ReaderT.Put(x)

Parameters:
    x : 'S

Returns: ReaderT<'R, ^MonadState<'S,unit>>
Modifiers: inline
Type parameters: ^MonadState<'S, unit>

x : 'S
Returns: ReaderT<'R, ^MonadState<'S,unit>>

ReaderT.Return(x)

Full Usage: ReaderT.Return(x)

Parameters:
    x : 'T

Returns: ReaderT<'R, ^Monad<'T>>
Modifiers: inline
Type parameters: ^Monad<'T>

x : 'T
Returns: ReaderT<'R, ^Monad<'T>>

ReaderT.Tell(w)

Full Usage: ReaderT.Tell(w)

Parameters:
    w : 'Monoid

Returns: ReaderT<'R, ^MonadWriter<'Monoid,unit>>
Modifiers: inline
Type parameters: ^MonadWriter<'Monoid,unit>

w : 'Monoid
Returns: ReaderT<'R, ^MonadWriter<'Monoid,unit>>

ReaderT.Throw(x)

Full Usage: ReaderT.Throw(x)

Parameters:
    x : 'E

Returns: ReaderT<'R, ^MonadError<'E,'T>>
Modifiers: inline
Type parameters: ^MonadError<'E,'T>

x : 'E
Returns: ReaderT<'R, ^MonadError<'E,'T>>

ReaderT.TryFinally(computation, f)

Full Usage: ReaderT.TryFinally(computation, f)

Parameters:
    computation : ReaderT<'R, ^Monad<'T>>
    f : unit -> unit

Returns: ReaderT<'R, ^Monad<'T>>
Modifiers: inline

computation : ReaderT<'R, ^Monad<'T>>
f : unit -> unit
Returns: ReaderT<'R, ^Monad<'T>>

ReaderT.TryWith(source, f)

Full Usage: ReaderT.TryWith(source, f)

Parameters:
Returns: ReaderT<'R, ^Monad<'T>>
Modifiers: inline

source : ReaderT<'R, ^Monad<'T>>
f : exn -> ReaderT<'R, ^Monad<'T>>
Returns: ReaderT<'R, ^Monad<'T>>

ReaderT.Using(resource, f)

Full Usage: ReaderT.Using(resource, f)

Parameters:
    resource : 'a
    f : 'a -> ReaderT<'R, ^Monad<'T>>

Returns: ReaderT<'R, ^Monad<'T>>
Modifiers: inline
Type parameters: ^Monad<'T>

resource : 'a
f : 'a -> ReaderT<'R, ^Monad<'T>>
Returns: ReaderT<'R, ^Monad<'T>>

ReaderT.Zip(x, y)

Full Usage: ReaderT.Zip(x, y)

Parameters:
Returns: ReaderT<'S, ^d>
Modifiers: inline

x : ReaderT<'S, ^Monad<'T>>
y : ReaderT<'S, ^Monad<'U>>
Returns: ReaderT<'S, ^d>

ReaderT.get_Ask ()

Full Usage: ReaderT.get_Ask ()

Returns: ReaderT<'R, ^Monad<'T>>
Modifiers: inline

Returns: ReaderT<'R, ^Monad<'T>>

ReaderT.get_Empty ()

Full Usage: ReaderT.get_Empty ()

Returns: ReaderT<'R, ^MonadPlus<'T>>
Modifiers: inline

Returns: ReaderT<'R, ^MonadPlus<'T>>

ReaderT.get_Get ()

Full Usage: ReaderT.get_Get ()

Returns: ReaderT<'R, ^MonadState<'S,'S>>
Modifiers: inline

Returns: ReaderT<'R, ^MonadState<'S,'S>>