Packages

  • package root
    Definition Classes
    root
  • package h8io
    Definition Classes
    root
  • package stages
    Definition Classes
    h8io
  • package base

    Type aliases used throughout the lib module for describing stage transformations.

    Type aliases used throughout the lib module for describing stage transformations.

    // A decorator is a stage itself: it wraps a Stage[I, O, E] and is one:
val myDecorator: Decorator[String, Int, Nothing] = CompleteIfNone(stage)

// A decoration is the function building it; an alteration is the same with the types free to change:
val myDecoration: Decoration[String, Int, Nothing] = CompleteIfNone(_)
val myAlteration: Alteration[Stage[String, Int, Nothing], Stage[String, Option[Int], Nothing]] = Lift(_)
    Definition Classes
    stages
  • package cats
    Definition Classes
    stages
  • package cycles
    Definition Classes
    stages
  • package operators
    Definition Classes
    stages
  • package projections
    Definition Classes
    stages
  • package std
    Definition Classes
    stages
  • Evolution
  • Stage
  • Status
  • Yield

object Yield

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Yield
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class None[-I, +O, +E](status: Status[E], evolution: Evolution[I, O, E]) extends Yield[I, O, E] with Product with Serializable

    A yield carrying no output — a filter dropping an input, a stage with nothing to report yet.

    A yield carrying no output — a filter dropping an input, a stage with nothing to report yet. The status and the evolution are still there, so the pipeline continues as usual.

    I

    the input type of the stages held by the evolution (contravariant)

    O

    the output type never produced here (covariant)

    E

    the error type (covariant)

    status

    the status of the run that produced this yield

    evolution

    the continuation

  2. final case class Some[-I, +O, +E](out: O, status: Status[E], evolution: Evolution[I, O, E]) extends Yield[I, O, E] with Product with Serializable

    A yield carrying an output.

    A yield carrying an output.

    In a pipeline the output becomes the downstream stage's input, and the two yields are merged into one.

    I

    the input type of the stages held by the evolution (contravariant)

    O

    the output type (covariant)

    E

    the error type (covariant)

    out

    the output value

    status

    the status of the run that produced this yield

    evolution

    the continuation

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 apply[I, O, E](out: Option[O], status: Status[E], evolution: Evolution[I, O, E]): Yield[I, O, E]

    Selects the variant by the optional output: scala.Some gives a Yield.Some, scala.None a Yield.None.

    Selects the variant by the optional output: scala.Some gives a Yield.Some, scala.None a Yield.None. For when the presence of an output is only known at runtime.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. def unapply[I, O, E](yld: Yield[I, O, E]): scala.Some[(Option[O], Status[E], Evolution[I, O, E])]

    Matches any yield as Yield(out, status, evolution) with the output optional — the inverse of apply, for the cases where both variants are treated uniformly.

    Matches any yield as Yield(out, status, evolution) with the output optional — the inverse of apply, for the cases where both variants are treated uniformly. The scala.Some return type marks the extractor as irrefutable: a single case Yield(...) is exhaustive.

    The components are read off the yield directly: outOption is exactly the optional output this extractor is for, and both variants carry the status and the evolution alike.

  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 AnyRef

Inherited from Any

Ungrouped