final class Sink[In, Mat] extends Graph[SinkShape[In], Mat]
Java API
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 GraphMapMatVal
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Sink(delegate: scaladsl.Sink[In, Mat])
Type Members
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Sink[In, Mat], B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asScala: scaladsl.Sink[In, Mat]
Converts this Sink to its Scala DSL counterpart.
-
def
async(dispatcher: String, inputBufferSize: Int): Sink[In, Mat]
Put an asynchronous boundary around this
Sink
-
def
async(dispatcher: String): Sink[In, Mat]
Put an asynchronous boundary around this
Sink
-
def
async: Sink[In, Mat]
Put an asynchronous boundary around this
Sink
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
contramap[In2](f: Function[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 ensuring(cond: (Sink[In, Mat]) ⇒ Boolean, msg: ⇒ Any): Sink[In, Mat]
- def ensuring(cond: (Sink[In, Mat]) ⇒ Boolean): Sink[In, Mat]
- def ensuring(cond: Boolean, msg: ⇒ Any): Sink[In, Mat]
- def ensuring(cond: Boolean): Sink[In, Mat]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def getAttributes: Attributes
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
mapMaterializedValue[Mat2](f: Function[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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
preMaterialize(materializer: Materializer): Pair[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.
Prefer the method taking an ActorSystem unless you have special requirements.
-
def
preMaterialize(systemProvider: ClassicActorSystemProvider): Pair[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 the
ActorSystem
can be used as thesystemProvider
parameter.Note that
preMaterialize
is implemented through a reactive streamsSubscriber
which means that a buffer is introduced and that errors are not propagated upstream but are turned into cancellations without error details. -
def
runWith[M](source: Graph[SourceShape[In], M], materializer: Materializer): M
Connect this
Sink
to aSource
and run it. -
def
runWith[M](source: Graph[SourceShape[In], M], systemProvider: ClassicActorSystemProvider): M
Connect this
Sink
to aSource
and run it.Connect this
Sink
to aSource
and run it.Note that the
ActorSystem
can be used as thesystemProvider
parameter. -
def
shape: SinkShape[In]
The shape of a graph is all that is externally visible: its inlets and outlets.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- Sink → AnyRef → Any
-
def
traversalBuilder: LinearTraversalBuilder
INTERNAL API.
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withAttributes(attr: Attributes): Sink[In, Mat]
Replace the attributes of this Sink with the given ones.
- def →[B](y: B): (Sink[In, Mat], B)
Shadowed Implicit Value Members
-
def
mapMaterializedValue[M2](f: (Mat) ⇒ M2): Graph[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 GraphMapMatVal[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
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Sink[In, Mat] to StringFormat[Sink[In, Mat]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.