Packages

c

h8io.stages.base

StageOps

implicit final class StageOps[I, O, E] extends AnyVal

Extension methods for Stage.

Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StageOps
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StageOps(stage: Stage[I, O, E])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def execute(in: I): Outcome[O, E]

    Executes this stage end-to-end and returns a plain Outcome.

    Executes this stage end-to-end and returns a plain Outcome.

    This is the reference terminal driver of the pipeline model. Internally this method:

    1. Applies the stage to in, obtaining a h8io.stages.Yield.
    2. Disposes the h8io.stages.Evolution carried by the Yield — since execute is a terminal operation, the continuation is not needed and the resources held by the stage must be released immediately.
    3. Wraps the result in an Outcome.Some or Outcome.None.

    Disposal failures do not prevent the result from being returned. Any non-fatal exception raised by h8io.stages.Evolution.dispose is captured in Outcome.disposeFailure and the outcome is still produced. Fatal exceptions are not caught and will propagate.

    in

    the input value

    returns

    Outcome.Some if this stage produced an output, Outcome.None otherwise

  6. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  7. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  8. val stage: Stage[I, O, E]
  9. def toEvolution(dispose: () ⇒ Unit): ConstEvolution[I, O, E]

    Lifts this stage into a ConstEvolution that returns it for every status branch and runs dispose when disposed.

    Lifts this stage into a ConstEvolution that returns it for every status branch and runs dispose when disposed.

    The overload to reach for whenever the lifted stage is not the owner of what has to be released — an operator keeping the inner evolution as the cleanup handle of the generation it has just built, or a stage recovering from an exception with resources still to free.

    dispose

    the thunk h8io.stages.Evolution.dispose delegates to

    Annotations
    @inline()
  10. def toEvolution: Evolution[I, O, E]

    Lifts this stage into a ConstEvolution that returns it for every status branch.

    Lifts this stage into a ConstEvolution that returns it for every status branch.

    Useful inside the h8io.stages.cycles operators (h8io.stages.cycles.Loop, h8io.stages.cycles.Repeat, h8io.stages.cycles.Reduce and h8io.stages.cycles.Fold) to produce the evolution embedded in a Yield.

    Annotations
    @inline()
  11. def toString(): String
    Definition Classes
    Any

Inherited from AnyVal

Inherited from Any

Ungrouped