final case class Countdown[T](i: Long, n: Long) extends Endo[T, Nothing] with Endo[T, Nothing] with Product with Serializable
An endomorphic stage that passes its input through for exactly n invocations and then signals pipeline completion.
On each of the first n − 1 calls the stage yields h8io.stages.Status.Success and decrements its counter. On the
n-th call it yields h8io.stages.Status.Complete and resets to n. After any h8io.stages.Status.Complete the
stage also resets to n, ready for reuse.
Countdown is fully immutable: each state transition creates a new instance rather than mutating the current one.
Preconditions (checked at construction via assume):
n > 01 ≤ i ≤ n
- T
the value type passed through unchanged
- i
the remaining number of successful yields before completion (
1 ≤ i ≤ n)- n
the total period length (must be positive)
- Alphabetic
- By Inheritance
- Countdown
- Serializable
- Product
- Equals
- SAMStage
- Stagnation
- Evolution
- Fruitful
- Stage
- Function1
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Countdown(i: Long, n: Long)
- i
the remaining number of successful yields before completion (
1 ≤ i ≤ n)- n
the total period length (must be positive)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def andThen[A](g: (Yield[T, T, Nothing]) => A): (T) => A
- Definition Classes
- Function1
- Annotations
- @unspecialized()
- def apply(in: T): Some[T, T, Nothing]
Processes
inand returns the Yield carrying the optional output, the status and the continuation. - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def compose[_O, _E >: Nothing](that: Evolution[T, _O, _E]): Evolution[T, _O, _E]
Composes this evolution with the one downstream of it, so that for every status
- def compose[A](g: (A) => T): (A) => Yield[T, T, Nothing]
- Definition Classes
- Function1
- Annotations
- @unspecialized()
- def dispose(): Unit
Releases everything held by the Stage that produced this evolution.
Releases everything held by the Stage that produced this evolution. That stage is permanently unusable afterwards — neither applied nor skipped again — and this is the only place its resources are released.
Whoever terminates a pipeline is responsible for disposing the evolution of the final Yield, so that the continuation is released at once instead of being carried around. The reference terminal driver is the
executeextension method ofh8io.stages.basein the lib module.dispose()stays valid after evolve has been called on the same instance, and must then release everything still alive, including whatever building the continuation acquired.evolvehands over no ownership: this evolution remains the cleanup point for its lineage until the continuation has run and produced an evolution of its own, which takes the role over from that moment.Exceptions are not part of this contract: a stage whose
applythrows produces no yield and therefore no evolution, so there is nothing to dispose — it must clean up after itself (see the Lifecycle section in Stage).A no-op is a fine implementation for a stage holding nothing external.
- Definition Classes
- Stagnation → Evolution
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def evolve(status: Status[_]): Stage[T, T, Nothing]
The next stage, for the given status.
The next stage, for the given status.
May release what belongs to this generation alone — anything the returned stage and its own evolution will not reuse.
evolveand dispose are not mutually exclusive. Usually only one of them is called on an instance: a terminal driver disposes, a continuing pipeline evolves and drops the previous evolution. But a caller may do both, and operators owning their inner stage (Loop,Repeatand the rest ofh8io.stages.cyclesin the lib module) do exactly that — they evolve eagerly and keep the innerdisposeas the cleanup handle of the generation they just built.- Definition Classes
- Stagnation → Evolution
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val i: Long
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def map[_I, _O, _E](f: (Stage[T, T, Nothing]) => Stage[_I, _O, _E]): Evolution[_I, _O, _E]
Applies
fto every stage this evolution would return, leaving disposal delegated to it unchanged.Applies
fto every stage this evolution would return, leaving disposal delegated to it unchanged.The way an operator keeps its wrapping in place across generations: the continuation comes back wrapped the same way the current stage is.
- Definition Classes
- Evolution
- Annotations
- @inline()
- val n: Long
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def skip(): Evolution[T, T, Nothing]
Returns this stage's Evolution without consuming an input.
Returns this stage's Evolution without consuming an input.
Called instead of
applywhenever the stage takes part in a run but has nothing to process: the upstream yielded no output, or a binary operator excluded this branch. The evolution must be the one the stage would have returned had it run. Likeapply,skip()may perform side effects — a decorator, for instance, may advance or release the inner stage it owns. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Function1 → 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])
- final def ~>[_O, _E >: Nothing](that: Stage[T, _O, _E]): Stage[T, _O, _E]
Composes this stage with
that, feeding this stage's output into it.Composes this stage with
that, feeding this stage's output into it. See the Composition section above for what happens when there is no output to feed.- Definition Classes
- Stage
- Annotations
- @inline()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)