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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sink
  2. Graph
  3. AnyRef
  4. Any
Implicitly
  1. by GraphMapMatVal
  2. by SinkToCompletionStage
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Sink(traversalBuilder: LinearTraversalBuilder, shape: SinkShape[In])

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. If the specific attribute was already present on this graph this means the added attribute will be more specific than the existing one. If this Sink is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

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

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

  3. def async(dispatcher: String, inputBufferSize: Int): Sink[In, Mat]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    inputBufferSize

    Set the input buffer to this size for the graph

    Definition Classes
    → Graph
  4. def async(dispatcher: String): Sink[In, Mat]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    → Graph
  5. def async: Sink[In, Mat]

    Put an asynchronous boundary around this Source

    Put an asynchronous boundary around this Source

    Definition Classes
    → Graph
  6. 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 cancels

  7. def getAttributes: Attributes
    Definition Classes
    → Graph
  8. def mapMaterializedValue[Mat2](f: (Mat) => Mat2): Sink[In, Mat2]

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

  9. def named(name: String): Sink[In, Mat]

    Add a name attribute to this Sink.

    Add a name attribute to this Sink.

    Definition Classes
    → Graph
  10. def preMaterialize()(implicit materializer: Materializer): (Mat, Sink[In, NotUsed])

    Materializes this Sink, immediately returning (1) its materialized value, and (2) a new Sink that can be consume elements 'into' the pre-materialized one.

    Materializes this Sink, immediately returning (1) its materialized value, and (2) a new Sink that can be consume elements 'into' the pre-materialized one.

    Useful for when you need a materialized value of a Sink when handing it out to someone to materialize it for you.

    Note that preMaterialize is implemented through a reactive streams Subscriber which means that a buffer is introduced and that errors are not propagated upstream but are turned into cancellations without error details.

  11. def runWith[Mat2](source: [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.

    Note that the ActorSystem can be used as the implicit materializer parameter to use the akka.stream.SystemMaterializer for running the stream.

  12. val shape: SinkShape[In]

    The shape of a graph is all that is externally visible: its inlets and outlets.

    The shape of a graph is all that is externally visible: its inlets and outlets.

    Definition Classes
    → Graph
  13. val sink: Sink[In, Future[T]]
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toSinkToCompletionStage[In, T] performed by method SinkToCompletionStage in .This conversion will take place only if Mat is a subclass of Future[T] (Mat <: Future[T]).
    Definition Classes
    SinkToCompletionStage
  14. def toCompletionStage(): Sink[In, CompletionStage[T]]
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toSinkToCompletionStage[In, T] performed by method SinkToCompletionStage in .This conversion will take place only if Mat is a subclass of Future[T] (Mat <: Future[T]).
    Definition Classes
    SinkToCompletionStage
  15. def toString(): String
    Definition Classes
    Sink → AnyRef → Any
  16. val traversalBuilder: LinearTraversalBuilder

    INTERNAL API.

    INTERNAL API.

    Every materializable element must be backed by a stream layout module

    Definition Classes
    → Graph
  17. def withAttributes(attr: Attributes): Sink[In, Mat]

    Replace the attributes of this Sink with the given ones.

    Replace the attributes of this Sink with the given ones. If this Sink is a composite of multiple graphs, new attributes on the composite will be less specific than attributes set directly on the individual graphs of the composite.

    Definition Classes
    → Graph

Shadowed Implicit Value Members

  1. def mapMaterializedValue[M2](f: (Mat) => M2): [SinkShape[In], M2]

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

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

    f

    function to map the graph's materialized value

    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] to[SinkShape[In], Mat] performed by method GraphMapMatVal in akka.stream.Graph.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (sink: GraphMapMatVal[SinkShape[In], Mat]).mapMaterializedValue(f)
    Definition Classes
    GraphMapMatVal