Packages

final case class Or[-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, Either[LO, RO], E] with Product with Serializable

A binary operator that tries left first; if left produces no output, it falls back to right, wrapping the result in scala.util.Either.

Evaluation rules for a given input:

  • If left yields h8io.stages.Yield.Some, the result is Yield.Some(Left(leftOut), leftStatus, ...). right is **not** applied.
  • If left yields h8io.stages.Yield.None, right is applied:
    • right yields Some → Yield.Some(Right(rightOut), mergedStatus, ...).
    • right yields None → Yield.None(mergedStatus, ...).

Statuses are merged with combine.

I

the shared input type (contravariant)

LO

the left output type (covariant)

RO

the right output type (covariant)

E

the error type (covariant)

left

the preferred stage; tried first

right

the fallback stage; tried only when left yields no output

Linear Supertypes
Serializable, Product, Equals, BinaryOperator[Stage[I, LO, E], Stage[I, RO, E], I, Either[LO, RO], E], Stage[I, Either[LO, RO], E], (I) => Yield[I, Either[LO, RO], E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Or
  2. Serializable
  3. Product
  4. Equals
  5. BinaryOperator
  6. Stage
  7. Function1
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Or(left: Stage[I, LO, E], right: Stage[I, RO, E])

    left

    the preferred stage; tried first

    right

    the fallback stage; tried only when left yields no output

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def andThen[A](g: (Yield[I, Either[LO, RO], E]) => A): (I) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  5. def apply(in: I): Yield[I, Either[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.

    Definition Classes
    Or → Stage → Function1
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def compose[A](g: (A) => I): (A) => Yield[I, Either[LO, RO], E]
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val left: Stage[I, LO, E]

    The left sub-stage.

    The left sub-stage.

    Definition Classes
    Or → BinaryOperator
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val right: Stage[I, RO, E]

    The right sub-stage.

    The right sub-stage.

    Definition Classes
    Or → BinaryOperator
  18. def skip(): Evolution[I, Either[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.

    Definition Classes
    Or → Stage
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def ~>[_O, _E >: E](that: Stage[Either[LO, RO], _O, _E]): Stage[I, _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

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from BinaryOperator[Stage[I, LO, E], Stage[I, RO, E], I, Either[LO, RO], E]

Inherited from Stage[I, Either[LO, RO], E]

Inherited from (I) => Yield[I, Either[LO, RO], E]

Inherited from AnyRef

Inherited from Any

Ungrouped