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()
API MAY CHANGE
- Annotations
- @ApiMayChange()
- Source
- SourceWithContext.scala
- Alphabetic
- By Inheritance
- SourceWithContext
- GraphDelegate
- Graph
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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
-
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
- 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
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
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
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
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
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]
-
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
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]
- Definition Classes
- Graph
-
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. -
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. -
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
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).
This can be used as an escape hatch for operations that are not (yet) provided with automatic context propagation here.
- See also
-
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