Sink

Companion object Sink

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

Graph[SinkShape[In], Mat], AnyRef, Any

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

Sink
Graph
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
All

Instance Constructors

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

Type Members

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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
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
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.
Definition Classes
ArrowAssoc
Annotations
@inline()
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.

Definition Classes
Sink → Graph
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
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
Sink → Graph
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
Sink → Graph
def async: Sink[In, Mat]
Put an asynchronous boundary around this Sink
Put an asynchronous boundary around this Sink

Definition Classes
Sink → Graph
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate() @throws( ... )
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
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
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
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
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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()
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 name attribute to this Sink.
Add a name attribute to this Sink.

Definition Classes
Sink → Graph
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.
def runWith[M](source: Graph[SourceShape[In], M], materializer: Materializer): M
Connect this Sink to a Source and run it.
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
Sink → Graph
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Sink → AnyRef → Any
def traversalBuilder: LinearTraversalBuilder
INTERNAL API.
INTERNAL API.
Every materializable element must be backed by a stream layout module

Definition Classes
Sink → Graph
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )
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.
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
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.
Definition Classes
ArrowAssoc

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
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()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0

Definition Classes
Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any

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

Value Members

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

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

Value Members

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()

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

Value Members

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
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
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
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

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

Value Members

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.
Definition Classes
ArrowAssoc
Annotations
@inline()
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.
Definition Classes
ArrowAssoc

Ungrouped

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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
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
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.
Definition Classes
ArrowAssoc
Annotations
@inline()
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.

Definition Classes
Sink → Graph
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
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
Sink → Graph
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
Sink → Graph
def async: Sink[In, Mat]
Put an asynchronous boundary around this Sink
Put an asynchronous boundary around this Sink

Definition Classes
Sink → Graph
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate() @throws( ... )
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
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
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
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
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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()
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 name attribute to this Sink.
Add a name attribute to this Sink.

Definition Classes
Sink → Graph
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.
def runWith[M](source: Graph[SourceShape[In], M], materializer: Materializer): M
Connect this Sink to a Source and run it.
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
Sink → Graph
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Sink → AnyRef → Any
def traversalBuilder: LinearTraversalBuilder
INTERNAL API.
INTERNAL API.
Every materializable element must be backed by a stream layout module

Definition Classes
Sink → Graph
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )
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.
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
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.
Definition Classes
ArrowAssoc
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Packages

Sink

Companion object Sink

final class Sink[In, Mat] extends Graph[SinkShape[In], Mat]

Instance Constructors

Type Members

Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

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

Value Members

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

Value Members

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

Value Members

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

Value Members

Ungrouped

Packages

Sink 

Companion object Sink

final class Sink[In, Mat] extends Graph[SinkShape[In], Mat]

Instance Constructors

Type Members

Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

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

Value Members

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

Value Members

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

Value Members

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

Value Members

Ungrouped

Sink