Class/Object

io.iteratee

Iteratee

Related Docs: object Iteratee | package iteratee

Permalink

sealed class Iteratee[F[_], E, A] extends Serializable

An iteratee processes a stream of elements of type E and returns a value of type F[A].

F

A type constructor representing a context for effects

E

The type of the input data

A

The type of the calculated result

Self Type
Iteratee[F, E, A]
See also

io.iteratee.internal.Step

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Iteratee
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def apply(enumerator: Enumerator[F, E])(implicit F: Monad[F]): Iteratee[F, E, A]

    Permalink

    Advance this Iteratee with the given Enumerator.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def contramap[E2](f: (E2) ⇒ E)(implicit F: Functor[F]): Iteratee[F, E2, A]

    Permalink

    Transform the inputs to this Iteratee.

  8. final def discard(implicit F: Functor[F]): Iteratee[F, E, Unit]

    Permalink

    Create a new Iteratee that throws away the value this one returns.

  9. final def ensure[T](action: F[Unit])(implicit F: MonadError[F, T]): Iteratee[F, E, A]

    Permalink

    Ensure that an action will be performed when this iteratee is done, whether or not it succeeds.

  10. final def ensureEval[T](action: Eval[F[Unit]])(implicit F: MonadError[F, T]): Iteratee[F, E, A]

    Permalink

    Ensure that an action will be performed when this iteratee is done, whether or not it succeeds.

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def flatMap[B](f: (A) ⇒ Iteratee[F, E, B])(implicit F: Monad[F]): Iteratee[F, E, B]

    Permalink

    Map a function returning an Iteratee over the result.

  15. final def flatMapM[B](f: (A) ⇒ F[B])(implicit F: Monad[F]): Iteratee[F, E, B]

    Permalink

    Map a monadic function over the result of this Iteratee.

  16. final def fold[Z](ifCont: ((NonEmptyVector[E]) ⇒ Iteratee[F, E, A]) ⇒ Z, ifDone: (A, Vector[E]) ⇒ Z)(implicit F: Functor[F]): F[Z]

    Permalink

    Reduce this Iteratee to an effectful value using the given functions.

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def handleErrorWith[T](f: (T) ⇒ Iteratee[F, E, A])(implicit F: MonadError[F, T]): Iteratee[F, E, A]

    Permalink

    If this Iteratee has failed, use the provided function to recover.

  19. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  21. final def map[B](f: (A) ⇒ B)(implicit F: Functor[F]): Iteratee[F, E, B]

    Permalink

    Map a function over the result of this Iteratee.

  22. final def mapI[G[_]](f: FunctionK[F, G])(implicit arg0: Applicative[G], F: Applicative[F]): Iteratee[G, E, A]

    Permalink

    Transform the context of this Iteratee.

  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def run(implicit F: Monad[F]): F[A]

    Permalink

    Run this iteratee and close the stream so that it must produce an effectful value.

  27. final val state: F[Step[F, E, A]]

    Permalink
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. final def through[O](enumeratee: Enumeratee[F, O, E])(implicit F: Monad[F]): Iteratee[F, O, A]

    Permalink

    Create a new Iteratee that first processes values with the given Enumeratee.

  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def up[G[_]](implicit G: Applicative[G], F: Comonad[F], F0: Applicative[F]): Iteratee[G, E, A]

    Permalink

    Lift this Iteratee into a different context.

  32. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def zip[B](other: Iteratee[F, E, B])(implicit F: Applicative[F]): Iteratee[F, E, (A, B)]

    Permalink

    Zip this Iteratee with another to create an iteratee that returns a pair of their results.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped