Packages

Definition Classes: root

Definition Classes: root

Definition Classes: izumi

Current hierarchy (rendered: https://izumi.7mind.io/bio/media/bio-relationship-hierarchy.svg, use https://www.nomnoml.com/ to render)

[Functor2]<--[Bifunctor2]
[Bifunctor2]<--[ApplicativeError2]
[Functor2]<--[Applicative2]
[Applicative2]<--[Guarantee2]
[Applicative2]<--[Monad2]
[Guarantee2]<--[ApplicativeError2]
[ApplicativeError2]<--[Error2]
[Error2]<--[WeakTemporal2]
[WeakTemporal2]<--[Temporal2]
[Monad2]<--[Error2]
[Error2]<--[Bracket2]
[Bracket2]<--[Panic2]
[Panic2]<--[IO2]
[IO2]<--[WeakAsync2]
[WeakAsync2]<--[Async2]

[Monad2]<--[Parallel2]
[Parallel2]<--[WeakAsync2]
[Panic2]<--[Concurrent2]
[Parallel2]<--[Concurrent2]

Auxiliary algebras (rendered: https://izumi.7mind.io/bio/media/algebras.svg):

[cats.effect.*]<:--[CatsConversions]

[Fork2]<:--[Fiber2]

[BlockingIO2]

[Primitives2]

[Primitives2]<:--[Ref2]
[Primitives2]<:--[Semaphore2]
[Primitives2]<:--[Promise2]

[PrimitivesM2]
[PrimitivesM2]<:--[RefM2]
[PrimitivesM2]<:--[Mutex2]

[PrimitivesLocal2]
[PrimitivesLocal2]<--[FiberRef2]
[PrimitivesLocal2]<--[FiberLocal2]

[Entropy1]<:--[Entropy2]
[Clock1]<:--[Clock2]

[Scheduler2]

[UnsafeRun2]

Raw inheritance hierarchy (rendered: https://izumi.7mind.io/bio/media/bio-hierarchy.svg):

[Bifunctor2]<--[ApplicativeError2]
[Functor2]<--[Applicative2]
[Applicative2]<--[Guarantee2]
[Applicative2]<--[Monad2]
[Guarantee2]<--[ApplicativeError2]
[ApplicativeError2]<--[Error2]
[Monad2]<--[Error2]
[Error2]<--[Bracket2]
[Bracket2]<--[Panic2]
[Panic2]<--[IO2]

[Parallel2]<--[WeakAsync2]
[Parallel2]<--[Concurrent2]
[Concurrent2]<--[Async2]
[IO2]<--[WeakAsync2]
[WeakAsync2]<--[Async2]

[WeakTemporal2]<--[Temporal2]

current hierarchy roots:

bifunctor:

standalone:

Definition Classes

functional

Note

New BIO typeclass checklist:

[ ] - add syntax to `Syntax2` with the same name as the type
[ ] - add syntax for new root's `InnerF` with the same name as `InnerF` in `Syntax2`
[ ] - add new attachments in `RootInstanceLowPriority*`
[ ] - add conversion from itself to its `InnerF` to `RootInstanceLowPriority*`
      (conversions implicit priority: from most specific `InnerF` to least specific)
[ ] - add conversion to equivalent cats typeclass if applicable in `CatsConversions`
[ ] - update hierarchy graph above, re-render SVG
[ ] - add syntax tests in `SyntaxTest`, runtime tests if applicable

Real and raw (direct inheritance) hierarchies differ because of implicit ambiguities caused by inheritance: https://typelevel.org/blog/2016/09/30/subtype-typeclasses.html However, since Scala 3.7, the ambiguity problem has been resolved on Scala 3 using inverted given prioritization: https://contributors.scala-lang.org/t/joining-the-dots-on-recent-implicit-prioritization-changes-and-some-scala-history/6814/3 So, when or if we drop support for Scala 2, we can revisit the design, remove InnerF pattern and make real and raw hierarchy match.

object Exit

Definition Classes: bio

izumi.functional.bio.Exit

Failure

sealed trait Failure[+E] extends Exit[E, Nothing]

Linear Supertypes

Exit[E, Nothing], AnyRef, Any

Known Subclasses

Error, FailureUninterrupted, Interruption, Termination

Ordering

Alphabetic
By Inheritance

Inherited

Failure
Exit
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def asFailure: Some[Failure[E]]
Definition Classes
Failure → Exit
abstract def isInterrupted: Boolean
Definition Classes
Exit
abstract def isUninterrupted: Boolean
Definition Classes
Exit
abstract def leftMap[E1](f: (E) => E1): Exit[E1, Nothing]
Definition Classes
Exit
abstract def toEither: Either[List[Throwable], E]
abstract def toEitherCompound: Either[Throwable, E]
abstract def toThrowableEither(implicit ev: <:<[E, Throwable]): Either[Throwable, Nothing]
Definition Classes
Exit
abstract def toTry(implicit ev: <:<[E, Throwable]): Try[Nothing]
Definition Classes
Exit
abstract def trace: Trace[E]

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def asSuccess: None.type
Definition Classes
Failure → Exit
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def flatMap[E1 >: E, B](f: (Nothing) => Exit[E1, B]): Failure.this.type
Definition Classes
Failure → Exit
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isFailure: Boolean
Definition Classes
Failure → Exit
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isSuccess: Boolean
Definition Classes
Failure → Exit
final def map[B](f: (Nothing) => B): Failure.this.type
Definition Classes
Failure → Exit
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def toThrowable(conv: (E) => Throwable): Throwable
final def toThrowable(implicit ev: <:<[E, Throwable]): Throwable
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

Failure

sealed trait Failure[+E] extends Exit[E, Nothing]

Abstract Value Members

Concrete Value Members

Inherited from Exit[E, Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Failure

sealed trait Failure[+E] extends Exit[E, Nothing]

Abstract Value Members

Concrete Value Members

Inherited from Exit[E, Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped

Failure