FSharpPlus


OptionT<'monad>> Type

Monad Transformer for Option<'T>

Table of contents

Monad

Static members

Static member Description

f >=> g

Full Usage: f >=> g

Parameters:
Returns: 'T -> OptionT<^Monad>
Modifiers: inline

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

f : 'T -> OptionT<^Monad>
g : 'U -> OptionT<^Monad>
Returns: 'T -> OptionT<^Monad>

Other module members

Union cases

Union case Description

OptionT 'monad>

Full Usage: OptionT 'monad>

Parameters:
    Item : 'monad>

Item : 'monad>

Static members

Static member Description

arg0 + arg1

Full Usage: arg0 + arg1

Parameters:
Returns: OptionT<^MonadPlus>
Modifiers: inline
arg0 : OptionT<^a>
arg1 : OptionT<^MonadPlus>
Returns: OptionT<^MonadPlus>

f <*> x

Full Usage: f <*> x

Parameters:
Returns: OptionT<^Monad>
Modifiers: inline
f : OptionT<^Monad'U)>>
x : OptionT<^Monad>
Returns: OptionT<^Monad>

arg0 <|> arg1

Full Usage: arg0 <|> arg1

Parameters:
Returns: OptionT<^MonadPlus>
Modifiers: inline
arg0 : OptionT<^a>
arg1 : OptionT<^MonadPlus>
Returns: OptionT<^MonadPlus>

x >>= f

Full Usage: x >>= f

Parameters:
Returns: OptionT<^Monad>
Modifiers: inline
x : OptionT<^Monad>
f : 'T -> OptionT<^Monad>
Returns: OptionT<^Monad>

OptionT.CallCC(f)

Full Usage: OptionT.CallCC(f)

Parameters:
    f : ('T -> OptionT<'MonadCont<'R,option<'U>>>) -> OptionT<^MonadCont<'R,option<'T>>>

Returns: OptionT<^MonadCont<'R,option<'T>>>
Modifiers: inline
Type parameters: 'MonadCont<'R,option<'U>>, ^MonadCont<'R,option<'T>>
f : ('T -> OptionT<'MonadCont<'R,option<'U>>>) -> OptionT<^MonadCont<'R,option<'T>>>
Returns: OptionT<^MonadCont<'R,option<'T>>>

OptionT.Catch(m, h)

Full Usage: OptionT.Catch(m, h)

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

Returns: OptionT<^MonadError<'E2,'T>>
Modifiers: inline
Type parameters: ^MonadError<'E2,'T>, 'E1
m : OptionT<^MonadError<'E1,'T>>
h : 'E1 -> OptionT<^MonadError<'E2,'T>>
Returns: OptionT<^MonadError<'E2,'T>>

OptionT.Delay(body)

Full Usage: OptionT.Delay(body)

Parameters:
Returns: OptionT<^Monad>>
Modifiers: inline
body : unit -> OptionT<^Monad>>
Returns: OptionT<^Monad>>

OptionT.Lift(x)

Full Usage: OptionT.Lift(x)

Parameters:
    x : ^Monad<'T>

Returns: OptionT<^Monad>>
Modifiers: inline
x : ^Monad<'T>
Returns: OptionT<^Monad>>

OptionT.Lift2(f, x, y)

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

Parameters:
Returns: OptionT<^Monad>
Modifiers: inline
Type parameters: 'U, 'V, ^Monad<option<'T>, ^Monad<option<'U>, ^Monad<option<'V>
f : 'T -> 'U -> 'V
x : OptionT<^Monad>
y : OptionT<^Monad>
Returns: OptionT<^Monad>

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

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

Parameters:
Returns: OptionT<^Monad>
Modifiers: inline
Type parameters: 'U, 'V, 'W, ^Monad<option<'T>, ^Monad<option<'U>, ^Monad<option<'W>
f : 'T -> 'U -> 'V -> 'W
x : OptionT<^Monad>
y : OptionT<^Monad>
z : OptionT<^Monad>
Returns: OptionT<^Monad>

OptionT.LiftAsync(x)

Full Usage: OptionT.LiftAsync(x)

Parameters:
Returns: OptionT<^MonadAsync<'T>>
Modifiers: inline
x : Async<'T>
Returns: OptionT<^MonadAsync<'T>>

OptionT.Listen(m)

Full Usage: OptionT.Listen(m)

Parameters:
Returns: OptionT<^'MonadWriter<'Monoid,option<'T>>>
Modifiers: inline
m : OptionT<'a>
Returns: OptionT<^'MonadWriter<'Monoid,option<'T>>>

OptionT.Local(arg1, f)

Full Usage: OptionT.Local(arg1, f)

Parameters:
    arg0 : OptionT<^MonadReader<'R2,'T>>
    f : 'R1 -> 'R2

Returns: OptionT<^a>
Modifiers: inline
arg0 : OptionT<^MonadReader<'R2,'T>>
f : 'R1 -> 'R2
Returns: OptionT<^a>

OptionT.Map(x, f)

Full Usage: OptionT.Map(x, f)

Parameters:
Returns: OptionT<^Monad>
Modifiers: inline
Type parameters: ^Monad<option<'U>, 'T, 'U
x : OptionT<^Monad>
f : 'T -> 'U
Returns: OptionT<^Monad>

OptionT.Pass(m)

Full Usage: OptionT.Pass(m)

Parameters:
Returns: OptionT<^MonadWriter<'Monoid,option<'T>>>
Modifiers: inline
m : OptionT<^a>
Returns: OptionT<^MonadWriter<'Monoid,option<'T>>>

OptionT.Put(x)

Full Usage: OptionT.Put(x)

Parameters:
    x : 'S

Returns: OptionT<^MonadState>
Modifiers: inline
x : 'S
Returns: OptionT<^MonadState>

OptionT.Return(x)

Full Usage: OptionT.Return(x)

Parameters:
    x : 'T

Returns: OptionT<^Monad>
Modifiers: inline
Type parameters: ^Monad<option<'T>
x : 'T
Returns: OptionT<^Monad>

OptionT.Tell(w)

Full Usage: OptionT.Tell(w)

Parameters:
    w : 'Monoid

Returns: OptionT<^MonadWriter<'Monoid,unit>>
Modifiers: inline
w : 'Monoid
Returns: OptionT<^MonadWriter<'Monoid,unit>>

OptionT.Throw(x)

Full Usage: OptionT.Throw(x)

Parameters:
    x : 'E

Returns: OptionT<^a>
Modifiers: inline
x : 'E
Returns: OptionT<^a>

OptionT.TryFinally(computation, f)

Full Usage: OptionT.TryFinally(computation, f)

Parameters:
    computation : OptionT<^Monad>>
    f : unit -> unit

Returns: OptionT<^Monad>>
Modifiers: inline
computation : OptionT<^Monad>>
f : unit -> unit
Returns: OptionT<^Monad>>

OptionT.TryWith(source, f)

Full Usage: OptionT.TryWith(source, f)

Parameters:
Returns: OptionT<^Monad>>
Modifiers: inline
source : OptionT<^Monad>>
f : exn -> OptionT<^Monad>>
Returns: OptionT<^Monad>>

OptionT.Using(resource, f)

Full Usage: OptionT.Using(resource, f)

Parameters:
    resource : 'a
    f : 'a -> OptionT<^Monad>>

Returns: OptionT<^Monad>>
Modifiers: inline
Type parameters: ^Monad<option<'T>>
resource : 'a
f : 'a -> OptionT<^Monad>>
Returns: OptionT<^Monad>>

OptionT.get_Ask ()

Full Usage: OptionT.get_Ask ()

Returns: OptionT<^MonadReader<'R,option<'R>>>
Modifiers: inline
Returns: OptionT<^MonadReader<'R,option<'R>>>

OptionT.get_Empty ()

Full Usage: OptionT.get_Empty ()

Returns: OptionT<^MonadPlus>
Modifiers: inline
Returns: OptionT<^MonadPlus>

OptionT.get_Get ()

Full Usage: OptionT.get_Get ()

Returns: OptionT<^MonadState<'S,'S>>
Modifiers: inline
Returns: OptionT<^MonadState<'S,'S>>

OptionT.get_Zero ()

Full Usage: OptionT.get_Zero ()

Returns: OptionT<^MonadPlus>
Modifiers: inline
Returns: OptionT<^MonadPlus>