FSharpPlus


Reader Module

Namespace: FSharpPlus.Data

Assembly: FSharpPlus.dll

Basic operations on Reader

Functions and values

Function or value Description

Reader.apply arg1 arg2

Full Usage: Reader.apply arg1 arg2

Parameters:
Returns: Reader<'R, 'U>

arg0 : Reader<'R, ('T -> 'U)>
arg1 : Reader<'R, 'T>
Returns: Reader<'R, 'U>

Reader.ask

Full Usage: Reader.ask

Returns: Reader<'R, 'R>

Retrieves the monad environment.

Returns: Reader<'R, 'R>

Reader.bind f arg2

Full Usage: Reader.bind f arg2

Parameters:
Returns: Reader<'R, 'U>

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

Reader.local f m

Full Usage: Reader.local f m

Parameters:
    f : 'R1 -> 'R2 - The function to modify the environment.
    m : Reader<'R2, 'T> - Reader to run in the modified environment.

Returns: Reader<'R1, 'T>

Executes a computation in a modified environment.

f : 'R1 -> 'R2

The function to modify the environment.

m : Reader<'R2, 'T>

Reader to run in the modified environment.

Returns: Reader<'R1, 'T>

Reader.map f arg2

Full Usage: Reader.map f arg2

Parameters:
    f : 'T -> 'U
    arg1 : Reader<'R, 'T>

Returns: Reader<'R, 'U>

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

Reader.map2 mapping arg2 arg3

Full Usage: Reader.map2 mapping arg2 arg3

Parameters:
    mapping : 'T -> 'U -> 'V
    arg1 : Reader<'R, 'T>
    arg2 : Reader<'R, 'U>

Returns: Reader<'R, 'V>

Combines two Readers into one by applying a mapping function.

mapping : 'T -> 'U -> 'V
arg1 : Reader<'R, 'T>
arg2 : Reader<'R, 'U>
Returns: Reader<'R, 'V>

Reader.run arg1

Full Usage: Reader.run arg1

Parameters:
Returns: 'R -> 'T

arg0 : Reader<'R, 'T>
Returns: 'R -> 'T

Reader.zip x y

Full Usage: Reader.zip x y

Parameters:
Returns: Reader<'R, ('T * 'U)>

Zips two Readers into one.

x : Reader<'R, 'T>
y : Reader<'R, 'U>
Returns: Reader<'R, ('T * 'U)>