Trait/Object

play.api.libs.streams

Accumulator

Related Docs: object Accumulator | package streams

Permalink

sealed trait Accumulator[-E, +A] extends AnyRef

An accumulator of elements into a future of a result.

This is essentially a lightweight wrapper around a Sink that gets materialised to a Future, but provides convenient methods for working directly with that future as well as transforming the input.

Source
Accumulator.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Accumulator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def asJava: libs.streams.Accumulator[E, A]

    Permalink

    Convert this accumulator to a Java Accumulator.

    Convert this accumulator to a Java Accumulator.

    returns

    The Java accumulator.

  2. abstract def map[B](f: (A) ⇒ B)(implicit executor: ExecutionContext): Accumulator[E, B]

    Permalink

    Map the result of this accumulator to something else.

  3. abstract def mapFuture[B](f: (A) ⇒ Future[B])(implicit executor: ExecutionContext): Accumulator[E, B]

    Permalink

    Map the result of this accumulator to a future of something else.

  4. abstract def recover[B >: A](pf: PartialFunction[Throwable, B])(implicit executor: ExecutionContext): Accumulator[E, B]

    Permalink

    Recover from errors encountered by this accumulator.

  5. abstract def recoverWith[B >: A](pf: PartialFunction[Throwable, Future[B]])(implicit executor: ExecutionContext): Accumulator[E, B]

    Permalink

    Recover from errors encountered by this accumulator.

  6. abstract def run(elem: E)(implicit materializer: Materializer): Future[A]

    Permalink

    Run this accumulator by feeding a single element into it.

  7. abstract def run()(implicit materializer: Materializer): Future[A]

    Permalink

    Run this accumulator by feeding nothing into it.

  8. abstract def run(source: Source[E, _])(implicit materializer: Materializer): Future[A]

    Permalink

    Run this accumulator by feeding in the given source.

  9. abstract def through[F](flow: Flow[F, E, _]): Accumulator[F, A]

    Permalink

    Return a new accumulator that first feeds the input through the given flow before it goes through this accumulator.

  10. abstract def toSink: Sink[E, Future[A]]

    Permalink

    Convert this accumulator to a Sink that gets materialised to a Future.

Concrete 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 asInstanceOf[T0]: T0

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def ~>:(source: Source[E, _])(implicit materializer: Materializer): Future[A]

    Permalink

    Right associative operator alias for run.

    Right associative operator alias for run.

    This can be used for a more fluent DSL that matches the flow of the data, for example:

    val intAccumulator: Accumulator[Int, Int] = ...
    val source = Source(1 to 3)
    val intFuture = source ~>: intAccumulator
  21. def ~>:[F](flow: Flow[F, E, _]): Accumulator[F, A]

    Permalink

    Right associative operator alias for through.

    Right associative operator alias for through.

    This can be used for a more fluent DSL that matches the flow of the data, for example:

    val intAccumulator: Accumulator[Int, Unit] = ...
    val toInt = Flow[String].map(_.toInt)
    val stringAccumulator = toInt ~>: intAccumulator

Inherited from AnyRef

Inherited from Any

Ungrouped