Yield

h8io.stages.Yield
See theYield companion trait
object Yield

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Yield.type

Members list

Type members

Classlikes

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

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.

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.

Type parameters

E

the error type (covariant)

I

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

O

the output type never produced here (covariant)

Value parameters

evolution

the continuation

status

the status of the run that produced this yield

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Yield[I, O, E]
class Object
trait Matchable
class Any
Show all
final case class Some[-I, +O, +E](out: O, status: Status[E], evolution: Evolution[I, O, E]) extends Yield[I, O, E]

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.

Type parameters

E

the error type (covariant)

I

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

O

the output type (covariant)

Value parameters

evolution

the continuation

out

the output value

status

the status of the run that produced this yield

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Yield[I, O, E]
class Object
trait Matchable
class Any
Show all

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements.

The names of the product elements.

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type.

The name of the type.

Attributes

Inherited from:
Mirror

Value members

Concrete methods

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. For when the presence of an output is only known at runtime.

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.

Attributes

def unapply[I, O, E](yld: Yield[I, O, E]): 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. The scala.Some return type marks the extractor as irrefutable: a single case Yield(...) is exhaustive.

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.

Attributes