Packages

final class Sink[-In, +Mat] extends Graph[SinkShape[In], Mat]

A Sink is a set of stream processing steps that has one open input. Can be used as a Subscriber

Source
Sink.scala
Linear Supertypes
Graph[SinkShape[In], Mat], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sink
  2. Graph
  3. AnyRef
  4. Any
Implicitly
  1. by SinkToCompletionStage
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Sink(module: Module)

Type Members

  1. type Shape = SinkShape[In]

    Type-level accessor for the shape parameter of this graph.

    Type-level accessor for the shape parameter of this graph.

    Definition Classes
    Graph

Value Members

  1. def addAttributes(attr: Attributes): Sink[In, Mat]

    Add the given attributes to this Sink.

    Add the given attributes to this Sink. Further calls to withAttributes will not remove these attributes. Note that this operation has no effect on an empty Flow (because the attributes apply only to the contained processing stages).

    Definition Classes
    Sink → Graph
  2. def asJava: javadsl.Sink[In, Mat]

    Converts this Scala DSL element to it's Java DSL counterpart.

  3. def async: Sink[In, Mat]

    Put an asynchronous boundary around this Sink

    Put an asynchronous boundary around this Sink

    Definition Classes
    Sink → Graph
  4. def contramap[In2](f: (In2) ⇒ In): Sink[In2, Mat]

    Transform this Sink by applying a function to each *incoming* upstream element before it is passed to the Sink

    Transform this Sink by applying a function to each *incoming* upstream element before it is passed to the Sink

    Backpressures when original Sink backpressures

    Cancels when original Sink backpressures

  5. def mapMaterializedValue[Mat2](f: (Mat) ⇒ Mat2): Sink[In, Mat2]

    Transform only the materialized value of this Sink, leaving all other properties as they were.

  6. val module: Module
    Definition Classes
    Sink → Graph
  7. def named(name: String): Sink[In, Mat]

    Add a name attribute to this Sink.

    Add a name attribute to this Sink.

    Definition Classes
    Sink → Graph
  8. def runWith[Mat2](source: Graph[SourceShape[In], Mat2])(implicit materializer: Materializer): Mat2

    Connect this Sink to a Source and run it.

    Connect this Sink to a Source and run it. The returned value is the materialized value of the Source, e.g. the Subscriber of a Source#subscriber.

  9. val shape: SinkShape[In]
    Definition Classes
    Sink → Graph
  10. val sink: Sink[In, Future[T]]
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] to SinkToCompletionStage[In, T] performed by method SinkToCompletionStage in akka.stream.scaladsl. This conversion will take place only if Mat is a subclass of Future[T] (Mat <: Future[T]).
    Definition Classes
    SinkToCompletionStage
  11. def toCompletionStage(): Sink[In, CompletionStage[T]]
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] to SinkToCompletionStage[In, T] performed by method SinkToCompletionStage in akka.stream.scaladsl. This conversion will take place only if Mat is a subclass of Future[T] (Mat <: Future[T]).
    Definition Classes
    SinkToCompletionStage
  12. def toString(): String
    Definition Classes
    Sink → AnyRef → Any
  13. def withAttributes(attr: Attributes): Sink[In, Mat]

    Change the attributes of this Sink to the given ones and seal the list of attributes.

    Change the attributes of this Sink to the given ones and seal the list of attributes. This means that further calls will not be able to remove these attributes, but instead add new ones. Note that this operation has no effect on an empty Flow (because the attributes apply only to the contained processing stages).

    Definition Classes
    Sink → Graph