sealed trait UnlessShutdown[+A] extends Product with Serializable

The outcome of a computation (UnlessShutdown.Outcome) unless the computation has aborted due to a shutdown (UnlessShutdown.AbortedDueToShutdown).

A copy of scala.Option. We use a separate class to document the purpose.

A

The type of the outcome.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Known Subclasses
AbortedDueToShutdown, Outcome
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnlessShutdown
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def flatMap[B](f: (A) => UnlessShutdown[B]): UnlessShutdown[B]

    Monadically chain two outcome computations.

    Monadically chain two outcome computations. Abortion due to shutdown propagates.

  3. abstract def foreach(f: (A) => Unit): Unit

    Applies the function to the outcome if available

  4. abstract def map[B](f: (A) => B): UnlessShutdown[B]

    Transforms the outcome using the given function.

  5. abstract def onShutdown[B >: A](ifShutdown: => B): B

    Evaluate the argument upon abortion and otherwise return the outcome

    Evaluate the argument upon abortion and otherwise return the outcome

    Analogue to scala.Option.getOrElse.

  6. abstract def productArity: Int
    Definition Classes
    Product
  7. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  8. abstract def toRight[L](aborted: => L): Either[L, A]

    Convert the outcome into an scala.Right$ or scala.Left$(aborted) upon abortion.

  9. abstract def traverse[F[_], B](f: (A) => F[B])(implicit F: Applicative[F]): F[UnlessShutdown[B]]

    Applicative traverse for outcome computations.

    Applicative traverse for outcome computations. The given function is not applied upon abortion.

Concrete Value Members

  1. def productElementName(n: Int): String
    Definition Classes
    Product
  2. def productElementNames: Iterator[String]
    Definition Classes
    Product
  3. def productIterator: Iterator[Any]
    Definition Classes
    Product
  4. def productPrefix: String
    Definition Classes
    Product