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

Instance Constructors

  1. new Sink(delegate: scaladsl.Sink[In, Mat])

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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toany2stringadd[Sink[In, Mat]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Sink[In, Mat], B)
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toArrowAssoc[Sink[In, Mat]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
    SinkGraph
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asScala: scaladsl.Sink[In, Mat]

    Converts this Sink to its Scala DSL counterpart.

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

    Put an asynchronous boundary around this Sink

    Put an asynchronous boundary around this Sink

    dispatcher

    Run the graph on this dispatcher

    inputBufferSize

    Set the input buffer to this size for the graph

    Definition Classes
    SinkGraph
  10. def async(dispatcher: String): Sink[In, Mat]

    Put an asynchronous boundary around this Sink

    Put an asynchronous boundary around this Sink

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    SinkGraph
  11. def async: Sink[In, Mat]

    Put an asynchronous boundary around this Sink

    Put an asynchronous boundary around this Sink

    Definition Classes
    SinkGraph
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. 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

    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

  14. def ensuring(cond: (Sink[In, Mat]) => Boolean, msg: => Any): Sink[In, Mat]
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toEnsuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (Sink[In, Mat]) => Boolean): Sink[In, Mat]
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toEnsuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): Sink[In, Mat]
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toEnsuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): Sink[In, Mat]
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toEnsuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toStringFormat[Sink[In, Mat]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. 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.

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

    Add a name attribute to this Sink.

    Add a name attribute to this Sink.

    Definition Classes
    SinkGraph
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. 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.

  30. 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 the systemProvider parameter.

  31. def runWith[M](source: Graph[SourceShape[In], M], materializer: Materializer): M

    Connect this Sink to a Source and run it.

  32. def runWith[M](source: Graph[SourceShape[In], M], systemProvider: ClassicActorSystemProvider): M

    Connect this Sink to a Source and run it.

    Connect this Sink to a Source and run it.

    Note that the ActorSystem can be used as the systemProvider parameter.

  33. def 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
    SinkGraph
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    Sink → AnyRef → Any
  36. def traversalBuilder: LinearTraversalBuilder

    INTERNAL API.

    INTERNAL API.

    Every materializable element must be backed by a stream layout module

    Definition Classes
    SinkGraph
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. 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
    SinkGraph

Shadowed Implicit Value Members

  1. 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] toGraphMapMatVal[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

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (Sink[In, Mat], B)
    Implicit
    This member is added by an implicit conversion from Sink[In, Mat] toArrowAssoc[Sink[In, Mat]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Graph[SinkShape[In], Mat]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion GraphMapMatVal fromSink[In, Mat] to GraphMapMatVal[SinkShape[In], Mat]

Inherited by implicit conversion any2stringadd fromSink[In, Mat] to any2stringadd[Sink[In, Mat]]

Inherited by implicit conversion StringFormat fromSink[In, Mat] to StringFormat[Sink[In, Mat]]

Inherited by implicit conversion Ensuring fromSink[In, Mat] to Ensuring[Sink[In, Mat]]

Inherited by implicit conversion ArrowAssoc fromSink[In, Mat] to ArrowAssoc[Sink[In, Mat]]

Ungrouped