Packages

object ExitCase extends Serializable

Source
Bracket.scala
Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExitCase
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Error[+E](e: E) extends ExitCase[E] with Product with Serializable

    An ExitCase signaling completion in failure.

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 attempt[E, A](value: Either[E, A]): ExitCase[E]

    Converts from Scala's Either, which is often the result of MonadError's attempt operation, into an ExitCase.

  6. def canceled[E]: ExitCase[E]

    Alias for Canceled.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def complete[E]: ExitCase[E]

    Parametrized alias for the Completed data constructor.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def error[E](e: E): ExitCase[E]

    Alias for the Error data constructor.

  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. case object Canceled extends ExitCase[Nothing] with Product with Serializable

    An ExitCase signaling that the action was aborted.

    An ExitCase signaling that the action was aborted.

    As an example this can happen when we have a cancelable data type, like IO and the task yielded by bracket gets canceled when it's at its use phase.

    Thus Bracket allows you to observe interruption conditions and act on them.

  25. case object Completed extends ExitCase[Nothing] with Product with Serializable

    An ExitCase that signals successful completion.

    An ExitCase that signals successful completion.

    Note that "successful" is from the type of view of the MonadError type that's implementing Bracket. When combining such a type with EitherT or OptionT for example, this exit condition might not signal a successful outcome for the user, but it does for the purposes of the bracket operation.

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped