Iteratee

An Iteratee represents a computation over a stream of data.

At each step, the Iteratee receives a stream element of type I. It can then either signal that processing the stream should continue by returning a Left containing another Iteratee of the same type, or that processing is finished by returning a value of type O.

Classical iteratees always work on infinite streams. These, however, can be used on finite ones. At the end of the stream, if the Iteratee has not already signalled that processing should terminate, its endOfInput method is called to produce the final value.

Self Type: Iteratee[I, O]

Linear Supertypes

AnyRef, Any

Known Subclasses

ByteCharEnumeratee, CharJArrayElementEnumeratee, CharJValueEnumeratee, IdentityIteratee, JValueIteratee, JValueRowEnumeratee, StringIteratee

Abstract Value Members

abstract def endOfInput(): O

Signals that there will be no more data forthcoming.
Signals that there will be no more data forthcoming. The Iteratee must now produce its final value.
returns
The output of this Iteratee.
abstract def process(input: I): Either[Iteratee[I, O], O]

Consume one piece of input.
Consume one piece of input. If the computation is not finished, a new Iteratee is returned.
input
The data to consume.
returns
Either a new Iteratee or the final result.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[O2](f: (O) ⇒ O2): Iteratee[I, O2]

Produces an Iteratee that transforms the final result of this one.
Produces an Iteratee that transforms the final result of this one.
O2
The new final type.
f
The function to apply to the final value.
returns
A new iteratee which will eventually return a value of type O2.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package iteratee

trait Iteratee[-I, +O] extends AnyRef

Abstract Value Members

abstract def endOfInput(): O

abstract def process(input: I): Either[Iteratee[I, O], O]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def map[O2](f: (O) ⇒ O2): Iteratee[I, O2]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped