DeadEnd

h8io.stages.std.DeadEnd
See theDeadEnd companion object
sealed case class DeadEnd(_dispose: () => Unit) extends StaticStage[Any, Nothing, Nothing]

A terminal stage that never produces an output value.

Every invocation of apply returns a h8io.stages.Yield.None with h8io.stages.Status.Complete, immediately signaling that the pipeline is finished.

DeadEnd is the natural "end-of-stream" marker and is also returned by Countdown.apply when n ≤ 0 and by h8io.stages.operators.LocalSoftDeadline when the duration is non-positive.

An optional _dispose hook can be supplied at construction to release resources when the stage is disposed; the companion object DeadEnd uses a no-op hook.

Value parameters

_dispose

a thunk invoked by h8io.stages.Evolution.dispose; defaults to a no-op in the companion object

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait StaticStage[Any, Nothing, Nothing]
trait SAMStage[Any, Nothing, Nothing]
trait Stagnation[Any, Nothing, Nothing]
trait Evolution[Any, Nothing, Nothing]
trait Stage[Any, Nothing, Nothing]
trait Any => Yield[Any, Nothing, Nothing]
class Object
trait Matchable
class Any
Show all
Known subtypes
object DeadEnd

Members list

Value members

Concrete methods

final override def dispose(): Unit

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.

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 execute extension method of h8io.stages.base in 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. evolve hands 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 apply throws 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.

Attributes

Definition Classes
final override def process(in: Any): None[Nothing]

The processing logic for this stage.

The processing logic for this stage.

Value parameters

in

the input value

Attributes

Returns

a h8io.stages.base.StaticYield describing whether an output was produced and the resulting h8io.stages.Status

Definition Classes

Inherited methods

def andThen[A](g: Yield[Any, Nothing, Nothing] => A): Any => A

Composes two instances of Function1 in a new Function1, with this function applied first.

Composes two instances of Function1 in a new Function1, with this function applied first.

Type parameters

A

the result type of function g

Value parameters

g

a function R => A

Attributes

Returns

a new function f such that f(x) == g(apply(x))

Inherited from:
Function1
final override def apply(in: Any): Yield[Any, Nothing, Nothing]

Processes in and returns the Yield carrying the optional output, the status and the continuation.

Processes in and returns the Yield carrying the optional output, the status and the continuation.

A stage that throws from here must have released its own resources first — see the ''Lifecycle'' section above.

Attributes

Definition Classes
StaticStage -> Stage -> Function1
Inherited from:
StaticStage
final def compose[_O, _E >: Nothing](that: Evolution[Nothing, _O, _E]): Evolution[Any, _O, _E]

Composes this evolution with the one downstream of it, so that for every status

Composes this evolution with the one downstream of it, so that for every status

 composed(s) == self(s) ~> that(s)

This is how Yield composition carries both continuations of a pipeline forward; application code rarely calls it directly.

Attributes

Inherited from:
Evolution
def compose[A](g: A => Any): A => Yield[Any, Nothing, Nothing]

Composes two instances of Function1 in a new Function1, with this function applied last.

Composes two instances of Function1 in a new Function1, with this function applied last.

Type parameters

A

the type to which function g can be applied

Value parameters

g

a function A => T1

Attributes

Returns

a new function f such that f(x) == apply(g(x))

Inherited from:
Function1
final override def evolve(status: Status[_]): Stage[Any, Nothing, 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.

evolve and 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, Repeat and the rest of h8io.stages.cycles in the lib module) do exactly that — they evolve eagerly and keep the inner dispose as the cleanup handle of the generation they just built.

Attributes

Definition Classes
Inherited from:
Stagnation
final def map[_I, _O, _E](f: Stage[Any, Nothing, Nothing] => Stage[_I, _O, _E]): Evolution[_I, _O, _E]

Applies f to every stage this evolution would return, leaving disposal delegated to it unchanged.

Applies f to 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.

Attributes

Inherited from:
Evolution
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
final override def skip(): Evolution[Any, Nothing, Nothing]

Returns this stage's Evolution without consuming an input.

Returns this stage's Evolution without consuming an input.

Called instead of apply whenever 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. Like apply, skip() may perform side effects — a decorator, for instance, may advance or release the inner stage it owns.

Attributes

Definition Classes
Inherited from:
SAMStage
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Function1 -> Any
Inherited from:
Function1
final def ~>[_O, _E >: Nothing](that: Stage[Nothing, _O, _E]): Stage[Any, _O, _E]

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.

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.

Attributes

Inherited from:
Stage