Object/Class

cats.effect

ExitCase

Related Docs: class ExitCase | package effect

Permalink

object ExitCase extends Serializable

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

Type Members

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

    Permalink

    An ExitCase signaling completion in failure.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Canceled extends ExitCase[Nothing] with Product with Serializable

    Permalink

    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.

  5. object Completed extends ExitCase[Nothing] with Product with Serializable

    Permalink

    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.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def attempt[E, A](value: Either[E, A]): ExitCase[E]

    Permalink

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

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

    Permalink

    Alias for Canceled.

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def complete[E]: ExitCase[E]

    Permalink

    Parametrized alias for the Completed data constructor.

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def error[E](e: E): ExitCase[E]

    Permalink

    Alias for the Error data constructor.

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped