Iteratee
Related Docs:
trait Iteratee
| package iteratee
Create an play.api.libs.iteratee.Iteratee which consumes and concatenates all Input chunks
Create an play.api.libs.iteratee.Iteratee which consumes and concatenates all Input chunks
Example:
// Get all chunks of input def getAll: Iteratee[Array[Byte], Array[Byte]] = Iteratee.consume[Array[Byte]]()
Chunks type should be viewable as TraversableOnce
flatten a scala.concurrent.Future of play.api.libs.iteratee.Iteratee] into an Iteratee
flatten a scala.concurrent.Future of play.api.libs.iteratee.Iteratee] into an Iteratee
a promise of iteratee
Create an play.api.libs.iteratee.Iteratee which folds the content of the Input using a given function and an initial state
Create an play.api.libs.iteratee.Iteratee which folds the content of the Input using a given function and an initial state
Example:
// Count the number of input elements def count[E]: Iteratee[E, Int] = Iteratee.fold(0)((c, _) => c + 1)
initial state
a function folding the previous state and an input to a new state
The context to execute the supplied function with. The context is prepared on the calling thread before being used.
Create an play.api.libs.iteratee.Iteratee which folds the content of the Input using a given function and an initial state
Create an play.api.libs.iteratee.Iteratee which folds the content of the Input using a given function and an initial state
It also gives the opportunity to return a scala.concurrent.Future so that promises are combined in a complete reactive flow of logic.
initial state
a function folding the previous state and an input to a new promise of state
The context to execute the supplied function with. The context is prepared on the calling thread before being used.
Create an play.api.libs.iteratee.Iteratee which folds the content of the Input using a given function and an initial state.
Create an play.api.libs.iteratee.Iteratee which folds the content of the Input using a given function and an initial state.
Like foldM, but the fold can be completed earlier by returning a value of true in the future result.
initial state
a function folding the previous state and an input to a promise of state and a boolean indicating whether the fold is done
The context to execute the supplied function with. The context is prepared on the calling thread before being used.
Create an play.api.libs.iteratee.Iteratee which folds the content of the Input using a given function and an initial state
Create an play.api.libs.iteratee.Iteratee which folds the content of the Input using a given function and an initial state
M stands for Monadic which in this case means returning a scala.concurrent.Future for the function argument f, so that promises are combined in a complete reactive flow of logic.
initial state
a function folding the previous state and an input to a new promise of state
The context to execute the supplied function with. The context is prepared on the calling thread before being used.
the function that should be executed for every chunk
an play.api.libs.iteratee.Iteratee which executes a provided function for every chunk. Returns Done on EOF. Example:
// Get all chunks of input def printChunks: Iteratee[String, Unit] = Iteratee.foreach[String]( s => println(s) )
Consume all the chunks from the stream, and return a list.
Create an iteratee that takes the first element of the stream, if one occurs before EOF
an play.api.libs.iteratee.Iteratee which just ignores its input
Determines whether or not a stream contains any elements.
Determines whether or not a stream contains any elements. A stream can be empty if it has no inputs (except Input.EOF) or if it consists of only Input.Empty elements (and Input.EOF.) A stream is non-empty if it contains an Input.El.
This iteratee consumes the stream as far as the first EOF or Input.El, skipping over any Input.Empty elements. When it encounters an Input.EOF or Input.El it is Done.
Will consume intermediate Input.Empty elements but does not consume Input.El or Input.EOF.
an iteratee used repeatedly to compute a sequence of results
an play.api.libs.iteratee.Iteratee which pushes the input into the provided play.api.libs.iteratee.Iteratee, starting over again each time it terminates until an EOF is received, collecting a sequence of results of the different use of the iteratee
Ignore all the input of the stream, and return done when EOF is encountered.
Read up to n chunks from the stream stopping when that number of chunks have been read or the stream end is reached.
Read up to n chunks from the stream stopping when that number of chunks have been read or the stream end is reached. If the stream has fewer elements then only those elements are returned. Will consume intermediate Input.Empty elements but does not consume Input.EOF.
Various helper methods to construct, compose and traverse Iteratees.