Packages

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 that carries no output value.

This can occur when a stage decides not to emit a value for the current input (e.g. a filter stage that drops items). The pipeline still carries a Status and an Evolution so that processing can resume or terminate correctly.

When composing inside a Stage.AndThen, a None from the first stage is forwarded without invoking the second stage; instead, the second stage is wired into the evolution so that it will be applied when the pipeline eventually resumes.

I

the input type for the evolution stages (contravariant)

O

the (phantom) output type (covariant)

E

the error type (covariant)

status

the execution status

evolution

the evolution strategy for re-processing

Source
Yield.scala
Linear Supertypes
Serializable, Product, Equals, Yield[I, O, E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. None
  2. Serializable
  3. Product
  4. Equals
  5. Yield
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new None(status: Status[E], evolution: Evolution[I, O, E])

    status

    the execution status

    evolution

    the evolution strategy for re-processing

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val evolution: Evolution[I, O, E]

    The evolution strategy that determines which stage to invoke next, depending on status.

    The evolution strategy that determines which stage to invoke next, depending on status.

    Definition Classes
    NoneYield
  8. def evolve(): Stage[I, O, E]

    Returns the next Stage to invoke when the pipeline is ready to re-process.

    Returns the next Stage to invoke when the pipeline is ready to re-process.

    The stage returned depends on the current status: Status.Success yields the continuation for the normal path, Status.Complete for the finished path.

    returns

    the next Stage to use for re-processing

    Definition Classes
    Yield
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def map[_I, _O, _E](mapOut: (O) => _O, mapStatus: (Status[E]) => Status[_E], mapEvolution: (Evolution[I, O, E]) => Evolution[_I, _O, _E]): Yield[_I, _O, _E]

    Returns a new Yield with each component independently transformed.

    Returns a new Yield with each component independently transformed.

    _I

    the new input type for the evolution

    _O

    the new output type

    _E

    the new error type

    mapOut

    maps the output value (only applied in Yield.Some)

    mapStatus

    maps the status

    mapEvolution

    maps the evolution

    returns

    a transformed Yield

    Definition Classes
    NoneYield
  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. def outOption: Option[O]

    Returns scala.Some(out) if this is a Yield.Some, or scala.None if this is a Yield.None.

    Returns scala.Some(out) if this is a Yield.Some, or scala.None if this is a Yield.None.

    Prefer pattern-matching on Yield.Some / Yield.None when you also need the status or evolution. Use outOption when you only care about whether a value was produced.

    Definition Classes
    NoneYield
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val status: Status[E]

    The status produced by the stage that created this Yield.

    The status produced by the stage that created this Yield.

    Definition Classes
    NoneYield
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from Yield[I, O, E]

Inherited from AnyRef

Inherited from Any

Ungrouped