Class/Object

akka.stream.scaladsl

Sink

Related Docs: object Sink | package scaladsl

Permalink

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 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(traversalBuilder: LinearTraversalBuilder, shape: SinkShape[In])

    Permalink

Type Members

  1. type Shape = SinkShape[In]

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sink[In, Mat] to any2stringadd[Sink[In, Mat]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Sink[In, Mat], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sink[In, Mat] to ArrowAssoc[Sink[In, Mat]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if Mat is a subclass of Future[Nothing] (Mat <: Future[Nothing]).
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink

    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
    Sink → Graph

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def asJava[JIn <: In]: javadsl.Sink[JIn, Mat]

    Permalink

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

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

    Permalink

    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
    Sink → Graph

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

    Permalink

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    Sink → Graph

  11. def async: Sink[In, Mat]

    Permalink

    Put an asynchronous boundary around this Source

    Put an asynchronous boundary around this Source

    Definition Classes
    Sink → Graph

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  13. def contramap[In2](f: (In2) ⇒ In): Sink[In2, Mat]

    Permalink

    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

  14. def ensuring(cond: (Sink[In, Mat]) ⇒ Boolean, msg: ⇒ Any): Sink[In, Mat]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sink[In, Mat] to Ensuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: (Sink[In, Mat]) ⇒ Boolean): Sink[In, Mat]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sink[In, Mat] to Ensuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. def ensuring(cond: Boolean, msg: ⇒ Any): Sink[In, Mat]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sink[In, Mat] to Ensuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  17. def ensuring(cond: Boolean): Sink[In, Mat]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sink[In, Mat] to Ensuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  21. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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
    @inline()

  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink

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

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

    Permalink

    Add a name attribute to this Sink.

    Add a name attribute to this Sink.

    Definition Classes
    Sink → Graph

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. def preMaterialize()(implicit materializer: Materializer): (Mat, Sink[In, NotUsed])

    Permalink

    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.

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

    Permalink

    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.

  32. val shape: SinkShape[In]

    Permalink

    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
    Sink → Graph

  33. val sink: Sink[In, Future[T]]

    Permalink
    Implicit information
    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

  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  35. def toCompletionStage(): Sink[In, CompletionStage[T]]

    Permalink
    Implicit information
    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

  36. def toString(): String

    Permalink
    Definition Classes
    Sink → AnyRef → Any

  37. val traversalBuilder: LinearTraversalBuilder

    Permalink

    INTERNAL API.

    INTERNAL API.

    Every materializable element must be backed by a stream layout module

    Definition Classes
    Sink → Graph

  38. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  39. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. def withAttributes(attr: Attributes): Sink[In, Mat]

    Permalink

    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
    Sink → Graph

  42. def →[B](y: B): (Sink[In, Mat], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sink[In, Mat] to ArrowAssoc[Sink[In, Mat]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if Mat is a subclass of Future[Nothing] (Mat <: Future[Nothing]).
    Definition Classes
    ArrowAssoc

Inherited from Graph[SinkShape[In], Mat]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion SinkToCompletionStage from Sink[In, Mat] to SinkToCompletionStage[In, T]

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

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

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

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

Ungrouped