FSharpx.Extras


Iteratee Module

Types and nested modules

Type/Module Description

Binary

List

IterateeBuilder

Functions and values

Function or value Description

x *> y

Full Usage: x *> y

Parameters:
Returns: Iteratee<'a, 'c>
Modifiers: inline

Sequence actions, discarding the value of the first argument.

x : Iteratee<'a, 'b>
y : Iteratee<'a, 'c>
Returns: Iteratee<'a, 'c>

x <* y

Full Usage: x <* y

Parameters:
Returns: Iteratee<'a, 'b>
Modifiers: inline

Sequence actions, discarding the value of the second argument.

x : Iteratee<'a, 'b>
y : Iteratee<'a, 'c>
Returns: Iteratee<'a, 'b>

f <!> m

Full Usage: f <!> m

Parameters:
Returns: Iteratee<'c, 'b>
Modifiers: inline
f : 'a -> 'b
m : Iteratee<'c, 'a>
Returns: Iteratee<'c, 'b>

f <*> m

Full Usage: f <*> m

Parameters:
Returns: Iteratee<'a, 'c>
Modifiers: inline

Sequential application

f : Iteratee<'a, ('b -> 'c)>
m : Iteratee<'a, 'b>
Returns: Iteratee<'a, 'c>

<=<x

Full Usage: <=<x

Parameters:
Returns: ('d -> Iteratee<'b, 'a>) -> 'd -> Iteratee<'b, 'c>
Modifiers: inline

Right-to-left Kleisli composition

x : 'a -> Iteratee<'b, 'c>
Returns: ('d -> Iteratee<'b, 'a>) -> 'd -> Iteratee<'b, 'c>

f =<< m

Full Usage: f =<< m

Parameters:
Returns: Iteratee<'b, 'c>
Modifiers: inline
f : 'a -> Iteratee<'b, 'c>
m : Iteratee<'b, 'a>
Returns: Iteratee<'b, 'c>

(>=>) f g x

Full Usage: (>=>) f g x

Parameters:
Returns: Iteratee<'b, 'd>
Modifiers: inline

Left-to-right Kleisli composition

f : 'a -> Iteratee<'b, 'c>
g : 'c -> Iteratee<'b, 'd>
x : 'a
Returns: Iteratee<'b, 'd>

m >>. f

Full Usage: m >>. f

Parameters:
Returns: Iteratee<'a, 'c>
Modifiers: inline

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

m : Iteratee<'a, 'b>
f : Iteratee<'a, 'c>
Returns: Iteratee<'a, 'c>

m >>= f

Full Usage: m >>= f

Parameters:
Returns: Iteratee<'a, 'c>
Modifiers: inline
m : Iteratee<'a, 'b>
f : 'b -> Iteratee<'a, 'c>
Returns: Iteratee<'a, 'c>

ap m f

Full Usage: ap m f

Parameters:
Returns: Iteratee<'a, 'c>
Modifiers: inline

Sequential application

m : Iteratee<'a, 'b>
f : Iteratee<'a, ('b -> 'c)>
Returns: Iteratee<'a, 'c>

bind f i

Full Usage: bind f i

Parameters:
Returns: Iteratee<'b, 'c>
f : 'a -> Iteratee<'b, 'c>
i : Iteratee<'b, 'a>
Returns: Iteratee<'b, 'c>

catchError h i

Full Usage: catchError h i

Parameters:
Returns: Iteratee<'a, 'b>
h : exn -> Iteratee<'a, 'b>
i : Iteratee<'a, 'b>
Returns: Iteratee<'a, 'b>

checkContinue0 inner

Full Usage: checkContinue0 inner

Parameters:
Returns: Iteratee<'a, 'b> -> Iteratee<'a, 'b>
inner : (Iteratee<'a, 'b> -> Iteratee<'a, 'b>) -> (Stream<'a> -> Iteratee<'a, 'b>) -> Iteratee<'a, 'b>
Returns: Iteratee<'a, 'b> -> Iteratee<'a, 'b>

checkDone f

Full Usage: checkDone f

Parameters:
Returns: Iteratee<'a, 'b> -> Iteratee<'c, Iteratee<'a, 'b>>
f : (Stream<'a> -> Iteratee<'a, 'b>) -> Iteratee<'c, Iteratee<'a, 'b>>
Returns: Iteratee<'a, 'b> -> Iteratee<'c, Iteratee<'a, 'b>>

checkDoneEx extra f _arg1

Full Usage: checkDoneEx extra f _arg1

Parameters:
Returns: Iteratee<'a, Iteratee<'b, 'c>>
extra : Stream<'a>
f : (Stream<'b> -> Iteratee<'b, 'c>) -> Iteratee<'a, Iteratee<'b, 'c>>
_arg1 : Iteratee<'b, 'c>
Returns: Iteratee<'a, Iteratee<'b, 'c>>

continueI k

Full Usage: continueI k

Parameters:
Returns: Iteratee<'a, 'b>
k : Stream<'a> -> Iteratee<'a, 'b>
Returns: Iteratee<'a, 'b>

doneI x s

Full Usage: doneI x s

Parameters:
Returns: Iteratee<'b, 'a>
x : 'a
s : Stream<'b>
Returns: Iteratee<'b, 'a>

empty

Full Usage: empty

Returns: Iteratee<'T, unit>
Returns: Iteratee<'T, unit>

enumEOF _arg1

Full Usage: enumEOF _arg1

Parameters:
Returns: Iteratee<'c, 'b>
_arg1 : Iteratee<'a, 'b>
Returns: Iteratee<'c, 'b>

enumErr e _arg1

Full Usage: enumErr e _arg1

Parameters:
    e : exn
    _arg1 : 'a

Returns: Iteratee<'b, 'c>
e : exn
_arg1 : 'a
Returns: Iteratee<'b, 'c>

enumList xs

Full Usage: enumList xs

Parameters:
    xs : 'a list

Returns: Iteratee<'a, 'b> -> Iteratee<'a, 'b>
xs : 'a list
Returns: Iteratee<'a, 'b> -> Iteratee<'a, 'b>

iteratee

Full Usage: iteratee

Returns: IterateeBuilder
Returns: IterateeBuilder

joinI outher

Full Usage: joinI outher

Parameters:
Returns: Iteratee<'a, 'c>
outher : Iteratee<'a, Iteratee<'b, 'c>>
Returns: Iteratee<'a, 'c>

lift2 f a b

Full Usage: lift2 f a b

Parameters:
Returns: Iteratee<'d, 'c>
Modifiers: inline
f : 'a -> 'b -> 'c
a : Iteratee<'d, 'a>
b : Iteratee<'d, 'b>
Returns: Iteratee<'d, 'c>

map f m

Full Usage: map f m

Parameters:
Returns: Iteratee<'c, 'b>
Modifiers: inline
f : 'a -> 'b
m : Iteratee<'c, 'a>
Returns: Iteratee<'c, 'b>

opt i

Full Usage: opt i

Parameters:
Returns: Iteratee<'a, 'b option>
i : Iteratee<'a, 'b>
Returns: Iteratee<'a, 'b option>

returnI x

Full Usage: returnI x

Parameters:
    x : 'a

Returns: Iteratee<'b, 'a>
x : 'a
Returns: Iteratee<'b, 'a>

returnM x

Full Usage: returnM x

Parameters:
    x : 'a

Returns: Iteratee<'b, 'a>
Modifiers: inline
x : 'a
Returns: Iteratee<'b, 'a>

run i

Full Usage: run i

Parameters:
Returns: 'b
i : Iteratee<'a, 'b>
Returns: 'b

run_ i

Full Usage: run_ i

Parameters:
Returns: Choice<'b, exn>
i : Iteratee<'a, 'b>
Returns: Choice<'b, exn>

throw e

Full Usage: throw e

Parameters:
    e : exn

Returns: Iteratee<'a, 'b>
e : exn
Returns: Iteratee<'a, 'b>

tryFinally compensation i

Full Usage: tryFinally compensation i

Parameters:
    compensation : unit -> unit
    i : Iteratee<'a, 'b>

Returns: Iteratee<'a, 'b>
compensation : unit -> unit
i : Iteratee<'a, 'b>
Returns: Iteratee<'a, 'b>