final class Drain[-T, +R] extends AnyRef

A Drain is a streaming component] with one input port and no output port. As such it serves as a "point of exit" from a stream graph to other destinations (e.g. to memory, disk or the network).

T

the type of the data elements consumed

R

the type of "results" that the drain provides

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def async(dispatcherId: String = ""): Drain[T, R]

    Turns this Drain into one that causes the stream graph it's incorporated into to run asynchronously.

    Turns this Drain into one that causes the stream graph it's incorporated into to run asynchronously. If the given dispatcherId is empty the default dispatcher will be assigned if no other non-default assignment has been made for the async region the drain is placed in.

  6. def captureResult[P](promise: Promise[P])(implicit capture: Capture[R, P]): Drain[T, Unit]

    Turns this Drain into one that produces no result.

    Turns this Drain into one that produces no result. Rather the result of this drain fulfills the given Promise as soon as it becomes available. If the result of this drain is a Future, the Future layer is unwrapped.

    NOTE: The result of this call and the underlying drain share the same stage. This means that only one of them can be used (once) in any stream setup.

  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def contramap[A](f: (A) ⇒ T): Drain[A, R]

    Prepends this Drain with a Pipe that transforms all incoming elements with the given function.

  9. def dropResult: Drain[T, Unit]

    Turns this Drain into one that produces no result by simply dropping the result value.

    Turns this Drain into one that produces no result by simply dropping the result value.

    NOTE: The result of this call and the underlying drain share the same stage. This means that only one of them can be used (once) in any stream setup.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def mapResult[P](f: (R) ⇒ P): Drain[T, P]

    Turns this Drain into one with a different result by mapping over the result value.

    Turns this Drain into one with a different result by mapping over the result value.

    NOTE: The result of this call and the underlying drain share the same stage. This means that only one of them can be used (once) in any stream setup.

  17. def named(name: String): Drain.this.type

    Explicitly attaches the given name to this Drain.

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  21. val result: R
  22. def stage: Stage

    The Stage representation of this Drain.

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped