Packages

  • package root
    Definition Classes
    root
  • package izumi
    Definition Classes
    root
  • package functional
    Definition Classes
    izumi
  • package bio

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

    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:

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

[Fork2]<:--[Fiber2]

[BlockingIO2]

[Primitives2]

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

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

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

[UnsafeRun2]

    Raw inheritance hierarchy:

    [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.

  • package data
    Definition Classes
    bio
  • object Morphism1

    Definition Classes
    data
    Note

    if you're using Scala 2.12 and getting "no such method" or implicit-related errors when interacting with Morphism1, you must enable -Xsource:2.13 or -Xsource:3 compiler option. BIO does not work without -Xsource:2.13 or -Xsource:3 option on 2.12.

  • Instance

trait Instance[-F[_], +G[_]] extends AnyRef

When it's more convenient to write a polymorphic function using a class (or kind-projector's lambda syntax):

Lambda[FunctionK.Instance[F, G]](a => f(b(a)))
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Instance
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply[A](fa: F[A]): G[A]

Concrete 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 andThen[H[_]](f: Morphism1[G, H]): Morphism1[F, H]
    Annotations
    @inline()
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def compose[F1[_]](f: Morphism1[F1, F]): Morphism1[F1, G]
    Annotations
    @inline()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped