stages-pages
API
Generated with
stages-pages/h8io.stages/h8io.stages.cats/IOr

IOr

h8io.stages.cats.IOr
See theIOr companion object
final case class IOr[-I, +LO, +RO, +E](left: Stage[I, LO, E], right: Stage[I, RO, E]) extends BinaryOperator[Stage[I, LO, E], Stage[I, RO, E], I, Ior[LO, RO], E]

A binary operator that applies two stages independently to the same input and combines their outputs into a cats.data.Ior (inclusive-or).

All four combinations of left/right presence are handled:

Left result Right result Output
Yield.Some Yield.Some Ior.Both(l, r)
Yield.Some Yield.None Ior.Left(l)
Yield.None Yield.Some Ior.Right(r)
Yield.None Yield.None Yield.None

Unlike h8io.stages.operators.And (which skips right when left yields no output) and h8io.stages.operators.Or (which skips right when left yields one), IOr always applies both stages, making it the inclusive variant.

Statuses from both stages are merged with combine. The evolution pairs corresponding branches symmetrically (like h8io.stages.operators.IAnd).

Type parameters

E

the error type (covariant)

I

the shared input type (contravariant)

LO

the left output type (covariant)

RO

the right output type (covariant)

Value parameters

left

the stage producing the left side of the Ior

right

the stage producing the right side of the Ior

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait BinaryOperator[Stage[I, LO, E], Stage[I, RO, E], I, Ior[LO, RO], E]
trait Stage[I, Ior[LO, RO], E]
trait I => Yield[I, Ior[LO, RO], E]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def apply(in: I): Yield[I, Ior[LO, RO], 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

Definition Classes
Stage -> Function1
override def skip(): Evolution[I, Ior[LO, RO], 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

Definition Classes

Inherited methods

def andThen[A](g: Yield[I, Ior[LO, RO], 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, Ior[LO, RO], 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
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
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[Ior[LO, RO], _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
Generated with