class NestedMaterializationCancellationPolicy extends MandatoryAttribute
Nested materialization cancellation strategy provides a way to configure the cancellation behavior of stages that materialize a nested flow.
When cancelled before materializing their nested flows, these stages can either immediately cancel (default behavior) without materializing the nested flow or wait for the nested flow to materialize and then propagate the cancellation signal through it.
This applies to pekko.stream.scaladsl.FlowOps.flatMapPrefix, pekko.stream.scaladsl.Flow.futureFlow (and derivations such as pekko.stream.scaladsl.Flow.lazyFutureFlow). These operators either delay the nested flow's materialization or wait for a future to complete before doing so, in this period of time they may receive a downstream cancellation signal. When this happens these operators will behave according to this Attribute: when set to true they will 'stash' the signal and later deliver it to the materialized nested flow , otherwise these stages will immediately cancel without materializing the nested flow.
- Annotations
- @ApiMayChange()
- Source
- Attributes.scala
- Alphabetic
- By Inheritance
- NestedMaterializationCancellationPolicy
- MandatoryAttribute
- Attribute
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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 NestedMaterializationCancellationPolicy toany2stringadd[NestedMaterializationCancellationPolicy] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (NestedMaterializationCancellationPolicy, B)
- Implicit
- This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toArrowAssoc[NestedMaterializationCancellationPolicy] 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 ensuring(cond: (NestedMaterializationCancellationPolicy) => Boolean, msg: => Any): NestedMaterializationCancellationPolicy
- Implicit
- This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toEnsuring[NestedMaterializationCancellationPolicy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (NestedMaterializationCancellationPolicy) => Boolean): NestedMaterializationCancellationPolicy
- Implicit
- This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toEnsuring[NestedMaterializationCancellationPolicy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): NestedMaterializationCancellationPolicy
- Implicit
- This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toEnsuring[NestedMaterializationCancellationPolicy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): NestedMaterializationCancellationPolicy
- Implicit
- This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toEnsuring[NestedMaterializationCancellationPolicy] 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- val propagateToNestedMaterialization: Boolean
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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 NestedMaterializationCancellationPolicy toStringFormat[NestedMaterializationCancellationPolicy] 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,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (NestedMaterializationCancellationPolicy, B)
- Implicit
- This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toArrowAssoc[NestedMaterializationCancellationPolicy] 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.