trait FlowWithContextOps[+Out, +Ctx, +Mat] extends AnyRef
Shared stream operations for FlowWithContext and SourceWithContext that automatically propagate a context element with each data element.
- Annotations
- @ccompatUsedUntil213()
- Source
- FlowWithContextOps.scala
- Alphabetic
- By Inheritance
- FlowWithContextOps
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- type Repr[+O, +C] = ReprMat[O, C, Mat]
- abstract type ReprMat[+O, +C, +M] <: FlowWithContextOps[O, C, M] { type ReprMat[+OO, +CC, +MatMat] = FlowWithContextOps.this.ReprMat[OO,CC,MatMat] }
Abstract Value Members
- abstract def unsafeDataVia[Out2, Mat2](viaFlow: Graph[FlowShape[Out, Out2], Mat2]): Repr[Out2, Ctx]
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()
- abstract def via[Out2, Ctx2, Mat2](flow: 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).
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
- abstract def viaMat[Out2, Ctx2, Mat2, Mat3](flow: Graph[FlowShape[(Out, Ctx), (Out2, Ctx2)], Mat2])(combine: (Mat, Mat2) => Mat3): ReprMat[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).
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.
The
combinefunction is used to compose the materialized values of this flow and that flow into the materialized value of the resulting Flow.
Concrete 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 FlowWithContextOps[Out, Ctx, Mat] toany2stringadd[FlowWithContextOps[Out, Ctx, Mat]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (FlowWithContextOps[Out, Ctx, Mat], B)
- Implicit
- This member is added by an implicit conversion from FlowWithContextOps[Out, Ctx, Mat] toArrowAssoc[FlowWithContextOps[Out, Ctx, Mat]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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.
- def ensuring(cond: (FlowWithContextOps[Out, Ctx, Mat]) => Boolean, msg: => Any): FlowWithContextOps[Out, Ctx, Mat]
- Implicit
- This member is added by an implicit conversion from FlowWithContextOps[Out, Ctx, Mat] toEnsuring[FlowWithContextOps[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (FlowWithContextOps[Out, Ctx, Mat]) => Boolean): FlowWithContextOps[Out, Ctx, Mat]
- Implicit
- This member is added by an implicit conversion from FlowWithContextOps[Out, Ctx, Mat] toEnsuring[FlowWithContextOps[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): FlowWithContextOps[Out, Ctx, Mat]
- Implicit
- This member is added by an implicit conversion from FlowWithContextOps[Out, Ctx, Mat] toEnsuring[FlowWithContextOps[Out, Ctx, Mat]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): FlowWithContextOps[Out, Ctx, Mat]
- Implicit
- This member is added by an implicit conversion from FlowWithContextOps[Out, Ctx, Mat] toEnsuring[FlowWithContextOps[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(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.
- 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.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
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, 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.
- See also
- def logWithMarker(name: String, marker: (Out, Ctx) => LogMarker, extract: (Out) => Any = ConstantFun.scalaIdentityFunction)(implicit log: MarkerLoggingAdapter = null): Repr[Out, Ctx]
Context-preserving variant of akka.stream.scaladsl.FlowOps.logWithMarker.
Context-preserving variant of akka.stream.scaladsl.FlowOps.logWithMarker.
- 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.
- See also
- def mapAsync[Out2](parallelism: Int)(f: (Out) => Future[Out2]): Repr[Out2, Ctx]
Context-preserving variant of akka.stream.scaladsl.FlowOps.mapAsync.
Context-preserving variant of akka.stream.scaladsl.FlowOps.mapAsync.
- def mapAsyncPartitioned[Out2, P](parallelism: Int, perPartition: Int)(partitioner: (Out) => P)(f: (Out, P) => Future[Out2]): Repr[Out2, Ctx]
Context-preserving variant of akka.stream.scaladsl.FlowOps.mapAsyncPartitioned.
Context-preserving variant of akka.stream.scaladsl.FlowOps.mapAsyncPartitioned.
- def mapConcat[Out2](f: (Out) => IterableOnce[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)
- def mapContext[Ctx2](f: (Ctx) => Ctx2): Repr[Out, Ctx2]
Apply the given function to each context element (leaving the data elements unchanged).
- def mapError(pf: PartialFunction[Throwable, Throwable]): Repr[Out, Ctx]
Context-preserving variant of akka.stream.scaladsl.FlowOps.mapError.
Context-preserving variant of akka.stream.scaladsl.FlowOps.mapError.
- 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 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
Seqof corresponding context elements. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def throttle(cost: Int, per: FiniteDuration, maximumBurst: Int, costCalculation: (Out) => Int, mode: ThrottleMode): Repr[Out, Ctx]
Context-preserving variant of akka.stream.scaladsl.FlowOps.throttle.
Context-preserving variant of akka.stream.scaladsl.FlowOps.throttle.
- def throttle(cost: Int, per: FiniteDuration, costCalculation: (Out) => Int): Repr[Out, Ctx]
Context-preserving variant of akka.stream.scaladsl.FlowOps.throttle.
Context-preserving variant of akka.stream.scaladsl.FlowOps.throttle.
- def throttle(elements: Int, per: FiniteDuration, maximumBurst: Int, mode: ThrottleMode): Repr[Out, Ctx]
Context-preserving variant of akka.stream.scaladsl.FlowOps.throttle.
Context-preserving variant of akka.stream.scaladsl.FlowOps.throttle.
- def throttle(elements: Int, per: FiniteDuration): Repr[Out, Ctx]
Context-preserving variant of akka.stream.scaladsl.FlowOps.throttle.
Context-preserving variant of akka.stream.scaladsl.FlowOps.throttle.
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])
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 FlowWithContextOps[Out, Ctx, Mat] toStringFormat[FlowWithContextOps[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): (FlowWithContextOps[Out, Ctx, Mat], B)
- Implicit
- This member is added by an implicit conversion from FlowWithContextOps[Out, Ctx, Mat] toArrowAssoc[FlowWithContextOps[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.