FSharpx.Extras


Async Module

Functions and values

Function or value Description

x *> y

Full Usage: x *> y

Parameters:
Returns: Async<'b>
Modifiers: inline

Sequence actions, discarding the value of the first argument.

x : Async<'a>
y : Async<'b>
Returns: Async<'b>

x <* y

Full Usage: x <* y

Parameters:
Returns: Async<'a>
Modifiers: inline

Sequence actions, discarding the value of the second argument.

x : Async<'a>
y : Async<'b>
Returns: Async<'a>

f <!> m

Full Usage: f <!> m

Parameters:
    f : 'a -> 'b
    m : Async<'a>

Returns: Async<'b>
Modifiers: inline

Infix map

f : 'a -> 'b
m : Async<'a>
Returns: Async<'b>

f <*> m

Full Usage: f <*> m

Parameters:
Returns: Async<'b>
Modifiers: inline

Sequential application

f : Async<('a -> 'b)>
m : Async<'a>
Returns: Async<'b>

<=<x

Full Usage: <=<x

Parameters:
Returns: ('c -> Async<'a>) -> 'c -> Async<'b>
Modifiers: inline

Right-to-left Kleisli composition

x : 'a -> Async<'b>
Returns: ('c -> Async<'a>) -> 'c -> Async<'b>

f =<< m

Full Usage: f =<< m

Parameters:
Returns: Async<'b>
Modifiers: inline

Flipped >>=

f : 'a -> Async<'b>
m : Async<'a>
Returns: Async<'b>

(>=>) f g x

Full Usage: (>=>) f g x

Parameters:
Returns: Async<'c>
Modifiers: inline

Left-to-right Kleisli composition

f : 'a -> Async<'b>
g : 'b -> Async<'c>
x : 'a
Returns: Async<'c>

m >>. f

Full Usage: m >>. f

Parameters:
Returns: Async<'b>
Modifiers: inline

Sequentially compose two async actions, discarding any value produced by the first

m : Async<'a>
f : Async<'b>
Returns: Async<'b>

m >>= f

Full Usage: m >>= f

Parameters:
Returns: Async<'b>
Modifiers: inline

Sequentially compose two actions, passing any value produced by the first as an argument to the second.

m : Async<'a>
f : 'a -> Async<'b>
Returns: Async<'b>

ap m f

Full Usage: ap m f

Parameters:
Returns: Async<'b>
Modifiers: inline

Sequential application

m : Async<'a>
f : Async<('a -> 'b)>
Returns: Async<'b>

bind f m

Full Usage: bind f m

Parameters:
Returns: Async<'d>
Modifiers: inline
Type parameters: 'c, 'd

Sequentially compose two actions, passing any value produced by the second as an argument to the first.

f : 'c -> Async<'d>
m : Async<'c>
Returns: Async<'d>

foldM f s

Full Usage: foldM f s

Parameters:
    f : 'a -> 'b -> Async<'a>
    s : 'a

Returns: 'b seq -> Async<'a>
f : 'a -> 'b -> Async<'a>
s : 'a
Returns: 'b seq -> Async<'a>

lift2 f x y

Full Usage: lift2 f x y

Parameters:
Returns: Async<'f>
Modifiers: inline
Type parameters: 'd, 'e, 'f

Promote a function to a monad/applicative, scanning the monadic/applicative arguments from left to right.

f : 'd -> 'e -> 'f
x : Async<'d>
y : Async<'e>
Returns: Async<'f>

map f m

Full Usage: map f m

Parameters:
    f : 'c -> 'd
    m : Async<'c>

Returns: Async<'d>
Modifiers: inline
Type parameters: 'c, 'd

Transforms an async value by using a specified mapping function.

f : 'c -> 'd
m : Async<'c>
Returns: Async<'d>

mapM f x

Full Usage: mapM f x

Parameters:
    f : 'a -> Async<'b>
    x : 'a list

Returns: Async<'b list>
Modifiers: inline
f : 'a -> Async<'b>
x : 'a list
Returns: Async<'b list>

pipe m f

Full Usage: pipe m f

Parameters:
    m : Async<'a>
    f : 'a -> 'b

Returns: Async<'b>
Modifiers: inline

Flipped map

m : Async<'a>
f : 'a -> 'b
Returns: Async<'b>

pipe2 x y f

Full Usage: pipe2 x y f

Parameters:
Returns: Async<'c>
Modifiers: inline
x : Async<'a>
y : Async<'b>
f : 'a -> 'b -> 'c
Returns: Async<'c>

pipe3 x y z f

Full Usage: pipe3 x y z f

Parameters:
Returns: Async<'d>
Modifiers: inline
x : Async<'a>
y : Async<'b>
z : Async<'c>
f : 'a -> 'b -> 'c -> 'd
Returns: Async<'d>

returnM x

Full Usage: returnM x

Parameters:
    x : 'a

Returns: Async<'a>
Modifiers: inline

Inject a value into the async type

x : 'a
Returns: Async<'a>

sequence s

Full Usage: sequence s

Parameters:
Returns: Async<'a list>
Modifiers: inline
s : Async<'a> list
Returns: Async<'a list>