Packages

final class SourceWithContext[+Out, +Ctx, +Mat] extends GraphDelegate[SourceShape[(Out, Ctx)], Mat] with FlowWithContextOps[Out, Ctx, Mat]

A source that provides operations which automatically propagate the context of an element. Only a subset of common operations from FlowOps is supported. As an escape hatch you can use FlowWithContextOps.via to manually provide the context propagation for otherwise unsupported operations.

Can be created by calling Source.asSourceWithContext()

API MAY CHANGE

Annotations
@ApiMayChange()
Source
SourceWithContext.scala
Linear Supertypes
FlowWithContextOps[Out, Ctx, Mat], GraphDelegate[SourceShape[(Out, Ctx)], Mat], Graph[SourceShape[(Out, Ctx)], Mat], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SourceWithContext
  2. FlowWithContextOps
  3. GraphDelegate
  4. Graph
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Repr[+O, +C] = ReprMat[O, C, Mat]
    Definition Classes
    FlowWithContextOps
  2. type ReprMat[+O, +C, +M] = SourceWithContext[O, C, M]
    Definition Classes
    SourceWithContextFlowWithContextOps
  3. type Shape = SourceShape[(Out, Ctx)]

    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 SourceWithContext[Out, Ctx, Mat] to any2stringadd[SourceWithContext[Out, Ctx, Mat]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SourceWithContext[Out, Ctx, Mat], B)
    Implicit
    This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] to ArrowAssoc[SourceWithContext[Out, Ctx, 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): Graph[SourceShape[(Out, Ctx)], Mat]

    Add the given attributes to this Graph.

    Add the given attributes to this Graph. 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 Source 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
    Graph
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asJava[JOut >: Out, JCtx >: Ctx, JMat >: Mat]: javadsl.SourceWithContext[JOut, JCtx, JMat]
  9. def asSource: Source[(Out, Ctx), Mat]

    Stops automatic context propagation from here and converts this to a regular stream of a pair of (data, context).

  10. def async(dispatcher: String, inputBufferSize: Int): Graph[SourceShape[(Out, Ctx)], Mat]

    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
    Graph
  11. def async(dispatcher: String): Graph[SourceShape[(Out, Ctx)], Mat]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    dispatcher

    Run the graph on this dispatcher

    Definition Classes
    Graph
  12. def async: Graph[SourceShape[(Out, Ctx)], Mat]

    Put an asynchronous boundary around this Graph

    Put an asynchronous boundary around this Graph

    Definition Classes
    Graph
  13. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  14. def collect[Out2](f: PartialFunction[Out, Out2]): Repr[Out2, Ctx]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.collect.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.collect.

    Note, that the context of elements that are filtered out is skipped as well.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.collect

  15. def ensuring(cond: (SourceWithContext[Out, Ctx, Mat]) ⇒ Boolean, msg: ⇒ Any): SourceWithContext[Out, Ctx, Mat]
    Implicit
    This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] to Ensuring[SourceWithContext[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (SourceWithContext[Out, Ctx, Mat]) ⇒ Boolean): SourceWithContext[Out, Ctx, Mat]
    Implicit
    This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] to Ensuring[SourceWithContext[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): SourceWithContext[Out, Ctx, Mat]
    Implicit
    This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] to Ensuring[SourceWithContext[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): SourceWithContext[Out, Ctx, Mat]
    Implicit
    This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] to Ensuring[SourceWithContext[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def filter(pred: (Out) ⇒ Boolean): Repr[Out, Ctx]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.filter.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.filter.

    Note, that the context of elements that are filtered out is skipped as well.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.filter

  22. def filterNot(pred: (Out) ⇒ Boolean): Repr[Out, Ctx]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.filterNot.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.filterNot.

    Note, that the context of elements that are filtered out is skipped as well.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.filterNot

  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] to StringFormat[SourceWithContext[Out, Ctx, Mat]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def grouped(n: Int): Repr[Seq[Out], Seq[Ctx]]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.grouped.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.grouped.

    Each output group will be associated with a Seq of corresponding context elements.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.grouped

  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def log(name: String, extract: (Out) ⇒ Any = ConstantFun.scalaIdentityFunction)(implicit log: LoggingAdapter = null): Repr[Out, Ctx]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.log.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.log.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.log

  29. def map[Out2](f: (Out) ⇒ Out2): Repr[Out2, Ctx]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.map.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.map.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.map

  30. def mapAsync[Out2](parallelism: Int)(f: (Out) ⇒ Future[Out2]): Repr[Out2, Ctx]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.mapAsync.

  31. def mapConcat[Out2](f: (Out) ⇒ Iterable[Out2]): Repr[Out2, Ctx]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.mapConcat.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.mapConcat.

    The context of the input element will be associated with each of the output elements calculated from this input element.

    Example:

    def dup(element: String) = Seq(element, element)

    Input:

    ("a", 1) ("b", 2)

    inputElements.mapConcat(dup)

    Output:

    ("a", 1) ("a", 1) ("b", 2) ("b", 2)

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.mapConcat

  32. def mapContext[Ctx2](f: (Ctx) ⇒ Ctx2): Repr[Out, Ctx2]

    Apply the given function to each context element (leaving the data elements unchanged).

    Apply the given function to each context element (leaving the data elements unchanged).

    Definition Classes
    FlowWithContextOps
  33. def named(name: String): Graph[SourceShape[(Out, Ctx)], Mat]
    Definition Classes
    Graph
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. def runWith[Mat2](sink: Graph[SinkShape[(Out, Ctx)], Mat2])(implicit materializer: Materializer): Mat2

    Connect this akka.stream.scaladsl.SourceWithContext to a akka.stream.scaladsl.Sink and run it.

    Connect this akka.stream.scaladsl.SourceWithContext to a akka.stream.scaladsl.Sink and run it. The returned value is the materialized value of the Sink.

  38. final def shape: SourceShape[(Out, Ctx)]

    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
    GraphDelegate → Graph
  39. def sliding(n: Int, step: Int = 1): Repr[Seq[Out], Seq[Ctx]]

    Context-preserving variant of akka.stream.scaladsl.FlowOps.sliding.

    Context-preserving variant of akka.stream.scaladsl.FlowOps.sliding.

    Each output group will be associated with a Seq of corresponding context elements.

    Definition Classes
    FlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.sliding

  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def to[Mat2](sink: Graph[SinkShape[(Out, Ctx)], Mat2]): RunnableGraph[Mat]

    Connect this akka.stream.scaladsl.SourceWithContext to a akka.stream.scaladsl.Sink, concatenating the processing steps of both.

  42. def toMat[Mat2, Mat3](sink: Graph[SinkShape[(Out, Ctx)], Mat2])(combine: (Mat, Mat2) ⇒ Mat3): RunnableGraph[Mat3]

    Connect this akka.stream.scaladsl.SourceWithContext to a akka.stream.scaladsl.Sink, concatenating the processing steps of both.

  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. def via[Out2, Ctx2, Mat2](viaFlow: Graph[FlowShape[(Out, Ctx), (Out2, Ctx2)], Mat2]): Repr[Out2, Ctx2]

    Transform this flow by the regular flow.

    Transform this flow by the regular flow. The given flow must support manual context propagation by taking and producing tuples of (data, context).

    This can be used as an escape hatch for operations that are not (yet) provided with automatic context propagation here.

    Definition Classes
    SourceWithContextFlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.via

  45. def viaMat[Out2, Ctx2, Mat2, Mat3](flow: Graph[FlowShape[(Out, Ctx), (Out2, Ctx2)], Mat2])(combine: (Mat, Mat2) ⇒ Mat3): SourceWithContext[Out2, Ctx2, Mat3]

    Transform this flow by the regular flow.

    Transform this flow by the regular flow. The given flow must support manual context propagation by taking and producing tuples of (data, context).

    This can be used as an escape hatch for operations that are not (yet) provided with automatic context propagation here.

    The combine function is used to compose the materialized values of this flow and that flow into the materialized value of the resulting Flow.

    Definition Classes
    SourceWithContextFlowWithContextOps
    See also

    akka.stream.scaladsl.FlowOps.viaMat

  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. def withAttributes(attr: Attributes): SourceWithContext[Out, Ctx, Mat]

    Context-preserving variant of akka.stream.scaladsl.Source.withAttributes.

  50. def [B](y: B): (SourceWithContext[Out, Ctx, Mat], B)
    Implicit
    This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] to ArrowAssoc[SourceWithContext[Out, Ctx, Mat]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. 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 FlowWithContextOps[Out, Ctx, Mat]

Inherited from GraphDelegate[SourceShape[(Out, Ctx)], Mat]

Inherited from Graph[SourceShape[(Out, Ctx)], Mat]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SourceWithContext[Out, Ctx, Mat] to any2stringadd[SourceWithContext[Out, Ctx, Mat]]

Inherited by implicit conversion StringFormat from SourceWithContext[Out, Ctx, Mat] to StringFormat[SourceWithContext[Out, Ctx, Mat]]

Inherited by implicit conversion Ensuring from SourceWithContext[Out, Ctx, Mat] to Ensuring[SourceWithContext[Out, Ctx, Mat]]

Inherited by implicit conversion ArrowAssoc from SourceWithContext[Out, Ctx, Mat] to ArrowAssoc[SourceWithContext[Out, Ctx, Mat]]

Ungrouped