stages-pages
API
Generated with
stages-pages/h8io.stages/h8io.stages.base/BinaryOperator

BinaryOperator

h8io.stages.base.BinaryOperator
trait BinaryOperator[+LS <: Stage[I, _, _], +RS <: Stage[I, _, _], -I, +O, +E] extends Stage[I, O, E]

A h8io.stages.Stage that composes two sub-stages operating on the same input type.

Exception-safe disposal of both sub-stage evolutions is provided by BaseBinaryOperator.Evolution (in the base package object), which delegates to h8io.stages.Evolution.dispose: right.dispose() is called first, then left.dispose(), and a failure of the former does not prevent the latter.

Concrete subclasses (e.g. h8io.stages.operators.And, h8io.stages.operators.Or, h8io.stages.operators.IAnd) implement apply to define how the two sub-stages are combined.

Type parameters

E

the error type (covariant)

I

the shared input type (contravariant)

LS

the type of the left sub-stage (covariant, must accept input I)

O

the combined output type (covariant)

RS

the type of the right sub-stage (covariant, must accept input I)

Attributes

Graph
Supertypes
trait Stage[I, O, E]
trait I => Yield[I, O, E]
class Object
trait Matchable
class Any
Known subtypes
class IOr[I, LO, RO, E]
class IAnd[I, LO, RO, E]
class Or[I, LO, RO, E]

Members list

Value members

Abstract methods

def left: LS

The left sub-stage.

The left sub-stage.

Attributes

def right: RS

The right sub-stage.

The right sub-stage.

Attributes

Inherited methods

def andThen[A](g: Yield[I, O, E] => A): I => 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
def compose[A](g: A => I): A => Yield[I, O, E]

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
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 >: E](that: Stage[O, _O, _E]): Stage[I, _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

Inherited and Abstract methods

def apply(in: I): Yield[I, O, E]

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

Inherited from:
Stage
def skip(): Evolution[I, O, E]

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

Inherited from:
Stage
Generated with