final class SourceWithContext[Out, Ctx, +Mat] extends GraphDelegate[SourceShape[(Out, Ctx)], Mat]
A source that provides operations which automatically propagate the context of an element. Only a subset of common operations from Source is supported. As an escape hatch you can use SourceWithContext#via to manually provide the context propagation for otherwise unsupported operations.
Can be created by calling Source.asSourceWithContext
- Source
- SourceWithContext.scala
- Alphabetic
- By Inheritance
- SourceWithContext
- GraphDelegate
- Graph
- AnyRef
- Any
- by GraphMapMatVal
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SourceWithContext(delegate: scaladsl.SourceWithContext[Out, Ctx, Mat])
Type Members
- 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
- 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 SourceWithContext[Out, Ctx, Mat] toany2stringadd[SourceWithContext[Out, Ctx, Mat]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (SourceWithContext[Out, Ctx, Mat], B)
- Implicit
- This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] toArrowAssoc[SourceWithContext[Out, Ctx, 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): 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asScala: scaladsl.SourceWithContext[Out, Ctx, Mat]
- def asSource(): Source[Pair[Out, Ctx], Mat]
Stops automatic context propagation from here and converts this to a regular stream of a pair of (data, context).
- def async(dispatcher: String, inputBufferSize: Int): Graph[SourceShape[(Out, Ctx)], Mat]
Put an asynchronous boundary around this
GraphPut 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
- def async(dispatcher: String): Graph[SourceShape[(Out, Ctx)], Mat]
Put an asynchronous boundary around this
GraphPut an asynchronous boundary around this
Graph- dispatcher
Run the graph on this dispatcher
- Definition Classes
- Graph
- def async: Graph[SourceShape[(Out, Ctx)], Mat]
Put an asynchronous boundary around this
GraphPut an asynchronous boundary around this
Graph- Definition Classes
- Graph
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def collect[Out2](pf: PartialFunction[Out, Out2]): SourceWithContext[Out2, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.collect.
Context-preserving variant of akka.stream.javadsl.Source.collect.
Note, that the context of elements that are filtered out is skipped as well.
- 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] toEnsuring[SourceWithContext[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- 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] toEnsuring[SourceWithContext[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): SourceWithContext[Out, Ctx, Mat]
- Implicit
- This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] toEnsuring[SourceWithContext[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): SourceWithContext[Out, Ctx, Mat]
- Implicit
- This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] toEnsuring[SourceWithContext[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def filter(p: Predicate[Out]): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.filter.
Context-preserving variant of akka.stream.javadsl.Source.filter.
Note, that the context of elements that are filtered out is skipped as well.
- def filterNot(p: Predicate[Out]): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.filterNot.
Context-preserving variant of akka.stream.javadsl.Source.filterNot.
Note, that the context of elements that are filtered out is skipped as well.
- def getAttributes: Attributes
- Definition Classes
- Graph
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def grouped(n: Int): SourceWithContext[List[Out], List[Ctx], Mat]
Context-preserving variant of akka.stream.javadsl.Source.grouped.
Context-preserving variant of akka.stream.javadsl.Source.grouped.
Each output group will be associated with a
Seqof corresponding context elements. - def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def log(name: String): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Flow.log.
Context-preserving variant of akka.stream.javadsl.Flow.log.
- See also
- def log(name: String, log: LoggingAdapter): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Flow.log.
Context-preserving variant of akka.stream.javadsl.Flow.log.
- See also
- def log(name: String, extract: Function[Out, Any]): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Flow.log.
Context-preserving variant of akka.stream.javadsl.Flow.log.
- See also
- def log(name: String, extract: Function[Out, Any], log: LoggingAdapter): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.log.
Context-preserving variant of akka.stream.javadsl.Source.log.
- See also
- def logWithMarker(name: String, marker: Function2[Out, Ctx, LogMarker]): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.
Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.
- def logWithMarker(name: String, marker: Function2[Out, Ctx, LogMarker], log: MarkerLoggingAdapter): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.
Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.
- def logWithMarker(name: String, marker: Function2[Out, Ctx, LogMarker], extract: Function[Out, Any]): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.,
Context-preserving variant of akka.stream.javadsl.Flow.logWithMarker.,
- def logWithMarker(name: String, marker: Function2[Out, Ctx, LogMarker], extract: Function[Out, Any], log: MarkerLoggingAdapter): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.logWithMarker.
Context-preserving variant of akka.stream.javadsl.Source.logWithMarker.
- def map[Out2](f: Function[Out, Out2]): SourceWithContext[Out2, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.map.
Context-preserving variant of akka.stream.javadsl.Source.map.
- See also
- def mapAsync[Out2](parallelism: Int, f: Function[Out, CompletionStage[Out2]]): SourceWithContext[Out2, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.mapAsync.
Context-preserving variant of akka.stream.javadsl.Source.mapAsync.
- def mapAsyncPartitioned[Out2, P](parallelism: Int, perPartition: Int, partitioner: Function[Out, P], f: BiFunction[Out, P, CompletionStage[Out2]]): SourceWithContext[Out2, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.mapAsyncPartitioned.
Context-preserving variant of akka.stream.javadsl.Source.mapAsyncPartitioned.
- def mapConcat[Out2](f: Function[Out, _ <: Iterable[Out2]]): SourceWithContext[Out2, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.mapConcat.
Context-preserving variant of akka.stream.javadsl.Source.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)
- def mapContext[Ctx2](extractContext: Function[Ctx, Ctx2]): SourceWithContext[Out, Ctx2, Mat]
Apply the given function to each context element (leaving the data elements unchanged).
- def mapError(pf: PartialFunction[Throwable, Throwable]): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.mapError.
Context-preserving variant of akka.stream.javadsl.Source.mapError.
- def mapMaterializedValue[Mat2](f: Function[Mat, Mat2]): SourceWithContext[Out, Ctx, Mat2]
Context-preserving variant of akka.stream.javadsl.Source.mapMaterializedValue.
Context-preserving variant of akka.stream.javadsl.Source.mapMaterializedValue.
- def named(name: String): Graph[SourceShape[(Out, Ctx)], Mat]
Specifies the name of the Graph.
Specifies the name of the Graph. If the name is null or empty the name is ignored, i.e. #none is returned.
- Definition Classes
- Graph
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def runWith[M](sink: Graph[SinkShape[Pair[Out, Ctx]], M], materializer: Materializer): M
Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink and run it.
Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink and run it. The returned value is the materialized value of the
Sink.Prefer the method taking an ActorSystem unless you have special requirements.
- def runWith[M](sink: Graph[SinkShape[Pair[Out, Ctx]], M], systemProvider: ClassicActorSystemProvider): M
Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink and run it.
Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink and run it. The returned value is the materialized value of the
Sink. - 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
- def sliding(n: Int, step: Int = 1): SourceWithContext[List[Out], List[Ctx], Mat]
Context-preserving variant of akka.stream.javadsl.Source.sliding.
Context-preserving variant of akka.stream.javadsl.Source.sliding.
Each output group will be associated with a
Seqof corresponding context elements. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def throttle(cost: Int, per: Duration, maximumBurst: Int, costCalculation: Function[Out, Integer], mode: ThrottleMode): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.throttle.
Context-preserving variant of akka.stream.javadsl.Source.throttle.
- def throttle(cost: Int, per: Duration, costCalculation: Function[Out, Integer]): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.throttle.
Context-preserving variant of akka.stream.javadsl.Source.throttle.
- def throttle(elements: Int, per: Duration, maximumBurst: Int, mode: ThrottleMode): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.throttle.
Context-preserving variant of akka.stream.javadsl.Source.throttle.
- def throttle(elements: Int, per: Duration): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.throttle.
Context-preserving variant of akka.stream.javadsl.Source.throttle.
- def to[Mat2](sink: Graph[SinkShape[Pair[Out, Ctx]], Mat2]): RunnableGraph[Mat]
Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink, concatenating the processing steps of both.
- def toMat[Mat2, Mat3](sink: Graph[SinkShape[Pair[Out, Ctx]], Mat2], combine: Function2[Mat, Mat2, Mat3]): RunnableGraph[Mat3]
Connect this akka.stream.javadsl.SourceWithContext to a akka.stream.javadsl.Sink, concatenating the processing steps of both.
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unsafeDataVia[Out2, Mat2](viaFlow: Graph[FlowShape[Out, Out2], Mat2]): SourceWithContext[Out2, Ctx, Mat]
Transform this flow by the regular flow.
Transform this flow by the regular flow. The given flow works on the data portion of the stream and ignores the context.
The given flow *must* not re-order, drop or emit multiple elements for one incoming element, the sequence of incoming contexts is re-combined with the outgoing elements of the stream. If a flow not fulfilling this requirement is used the stream will not fail but continue running in a corrupt state and re-combine incorrect pairs of elements and contexts or deadlock.
For more background on these requirements see https://doc.akka.io/libraries/akka-core/current/stream/stream-context.html.
- Annotations
- @ApiMayChange()
- def via[Out2, Ctx2, Mat2](viaFlow: Graph[FlowShape[Pair[Out, Ctx], Pair[Out2, Ctx2]], Mat2]): SourceWithContext[Out2, Ctx2, Mat]
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).
It is up to the implementer to ensure the inner flow does not exhibit any behaviour that is not expected by the downstream elements, such as reordering. For more background on these requirements see https://doc.akka.io/libraries/akka-core/current/stream/stream-context.html.
This can be used as an escape hatch for operations that are not (yet) provided with automatic context propagation here.
- See also
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withAttributes(attr: Attributes): SourceWithContext[Out, Ctx, Mat]
Context-preserving variant of akka.stream.javadsl.Source.withAttributes.
Context-preserving variant of akka.stream.javadsl.Source.withAttributes.
- Definition Classes
- SourceWithContext → Graph
- See also
Shadowed Implicit Value Members
- def mapMaterializedValue[M2](f: (Mat) => M2): Graph[SourceShape[(Out, Ctx)], 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 SourceWithContext[Out, Ctx, Mat] toGraphMapMatVal[SourceShape[(Out, Ctx)], 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:(sourceWithContext: GraphMapMatVal[SourceShape[(Out, Ctx)], Mat]).mapMaterializedValue(f)
- Definition Classes
- GraphMapMatVal
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] toStringFormat[SourceWithContext[Out, Ctx, Mat]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (SourceWithContext[Out, Ctx, Mat], B)
- Implicit
- This member is added by an implicit conversion from SourceWithContext[Out, Ctx, Mat] toArrowAssoc[SourceWithContext[Out, Ctx, 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.