Packages

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
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(module: Module)

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] to any2stringadd[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] 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
    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. Further calls to withAttributes will not remove these attributes. Note that this operation has no effect on an empty Flow (because the attributes apply only to the contained processing stages).

    Definition Classes
    SinkGraph
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asJava: javadsl.Sink[In, Mat]

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

  9. def async: Sink[In, Mat]

    Put an asynchronous boundary around this Sink

    Put an asynchronous boundary around this Sink

    Definition Classes
    SinkGraph
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. 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 backpressures

  12. 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] to Ensuring[Sink[In, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Sink[In, Mat]) ⇒ Boolean): Sink[In, Mat]
    Implicit
    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
  14. def ensuring(cond: Boolean, msg: ⇒ Any): Sink[In, Mat]
    Implicit
    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: Boolean): Sink[In, Mat]
    Implicit
    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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. 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
    @inline()
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def mapMaterializedValue[Mat2](f: (Mat) ⇒ Mat2): Sink[In, Mat2]

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

  24. val module: Module
    Definition Classes
    SinkGraph
  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
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  29. def runWith[Mat2](source: Graph[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.

  30. val shape: SinkShape[In]
    Definition Classes
    SinkGraph
  31. 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
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. 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
  34. def toString(): String
    Definition Classes
    Sink → AnyRef → Any
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def withAttributes(attr: Attributes): Sink[In, Mat]

    Change the attributes of this Sink to the given ones and seal the list of attributes.

    Change the attributes of this Sink to the given ones and seal the list of attributes. This means that further calls will not be able to remove these attributes, but instead add new ones. Note that this operation has no effect on an empty Flow (because the attributes apply only to the contained processing stages).

    Definition Classes
    SinkGraph
  39. def [B](y: B): (Sink[In, Mat], B)
    Implicit
    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