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
- Alphabetic
- By Inheritance
- Sink
- Graph
- AnyRef
- Any
- by SinkToCompletionStage
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
Value Members
-
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.
-
def
asJava[JIn <: In]: javadsl.Sink[JIn, Mat]
Converts this Scala DSL element to it's Java DSL counterpart.
-
def
async(dispatcher: String, inputBufferSize: Int): Sink[In, Mat]
Put an asynchronous boundary around this
Graph
-
def
async(dispatcher: String): Sink[In, Mat]
Put an asynchronous boundary around this
Graph
-
def
async: Sink[In, Mat]
Put an asynchronous boundary around this
Source
-
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
-
def
mapMaterializedValue[Mat2](f: (Mat) ⇒ Mat2): Sink[In, Mat2]
Transform only the materialized value of this Sink, leaving all other properties as they were.
-
def
named(name: String): Sink[In, Mat]
Add a
attribute to this Sink.name
-
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.
-
def
runWith[Mat2](source: Graph[SourceShape[In], Mat2])(implicit materializer: Materializer): Mat2
Connect this
Sink
to aSource
and run it.Connect this
Sink
to aSource
and run it. The returned value is the materialized value of theSource
, e.g. theSubscriber
of a Source#subscriber. -
val
shape: SinkShape[In]
The shape of a graph is all that is externally visible: its inlets and outlets.
-
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
-
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
-
def
toString(): String
- Definition Classes
- Sink → AnyRef → Any
-
val
traversalBuilder: LinearTraversalBuilder
INTERNAL API.
-
def
withAttributes(attr: Attributes): Sink[In, Mat]
Replace the attributes of this Sink with the given ones.