Packages

class CatsEffectInstancesModule[F[_]] extends ModuleDef

Adds cats-effect typeclass instances for any effect type F[_] with an available make[ConcurrentEffect[F] binding

Depends on ConcurrentEffect[F].

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CatsEffectInstancesModule
  2. ModuleDef
  3. ModuleDefDSL
  4. TagsDSL
  5. IncludesDSL
  6. AbstractBindingDefDSL
  7. AbstractBindingDefDSLMacro
  8. Module
  9. ModuleBase
  10. CachedHashcode
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CatsEffectInstancesModule()(implicit arg0: TagK[F])

Type Members

  1. final class MutationContext extends AnyRef

    Use this to create utility functions that add bindings mutably to the current module, as opposed to creating new modules and including them.

    Use this to create utility functions that add bindings mutably to the current module, as opposed to creating new modules and including them.

    Example:

    import distage.{ClassConstructor, Tag, ModuleDef}
    import izumi.distage.model.definition.dsl.ModuleDefDSL
    
    trait RegisteredComponent
    class RegisteredComponentImpl extends RegisteredComponent
    
    def addAndRegister[T <: RegisteredComponent: Tag: ClassConstructor](implicit mutateModule: ModuleDefDSL#MutationContext): Unit = {
      new mutateModule.dsl {
        make[T]
    
        many[RegisteredComponent]
          .weak[T]
      }
    }
    
    new ModuleDef {
      addAndRegister[RegisteredComponentImpl]
    }
    Definition Classes
    AbstractBindingDefDSL

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. def _initialIncludes: ArrayBuffer[Include]
    Attributes
    protected
    Definition Classes
    IncludesDSL
  5. def _initialState: ArrayBuffer[BindingRef]
    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
  6. def _initialTags: Set[BindingTag]
    Attributes
    protected
    Definition Classes
    TagsDSL
  7. final def _make[T](provider: Functoid[T])(implicit arg0: Tag[T], pos: CodePositionMaterializer): MakeDSL[T]
    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
  8. def _registered[T <: BindingRef](bindingRef: T): T
    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
  9. final def addImplicit[T](implicit arg0: Tag[T], instance: T, pos: CodePositionMaterializer): MakeDSLUnnamedAfterFrom[T]

    Same as make[T].from(implicitly[T]) *

    Same as make[T].from(implicitly[T]) *

    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. final def bindings: Set[Binding]
    Definition Classes
    ModuleDefDSL
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def equals(obj: Any): Boolean
    Definition Classes
    ModuleBase → AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def hash: Int
    Attributes
    protected
    Definition Classes
    ModuleBaseCachedHashcode
  18. final lazy val hashCode: Int
    Definition Classes
    CachedHashcode → AnyRef → Any
  19. final def include(that: ModuleBase, tagMergeStrategy: TagMergePolicy = TagMergePolicy.MergePreferInner): Unit

    Add all bindings in that module into this module

    Add all bindings in that module into this module

    WILL add outer tags / axis values from TagsDSL#tag to included bindings, unless they're overridden by tags / axis values in the included module.

    Attributes
    protected
    Definition Classes
    IncludesDSL
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def iterator: Iterator[Binding]
    Definition Classes
    ModuleDefDSL
  22. final def keys: Set[DIKey]
    Definition Classes
    ModuleBase
  23. final def keysIterator: Iterator[DIKey]
    Definition Classes
    ModuleDefDSL
  24. final macro def make[T]: MakeDSL[T]
    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSLMacro
  25. final def makeFactory[T](implicit arg0: Tag[T], arg1: FactoryConstructor[T]): MakeDSLUnnamedAfterFrom[T]

    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
    See also

    Auto-Factories feature

  26. final def makeSubcontext[T](implicit arg0: Tag[T]): SubcontextDSL[T]

    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
    See also

    Subcontexts feature

  27. final def makeSubcontext[T](submodule: ModuleBase)(implicit arg0: Tag[T]): SubcontextDSL[T]

    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
    See also

    Subcontexts feature

  28. final def makeTrait[T](implicit arg0: Tag[T], arg1: TraitConstructor[T]): MakeDSLUnnamedAfterFrom[T]

    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
    See also

    Auto-Traits feature

  29. final def many[T](implicit tag: Tag[Set[T]], pos: CodePositionMaterializer): SetDSL[T]

    Set bindings are useful for implementing event listeners, plugins, hooks, http routes, etc.

    Set bindings are useful for implementing event listeners, plugins, hooks, http routes, etc.

    To define a multibinding use .many and .add methods in ModuleDef DSL:

    import cats.effect._, org.http4s._, org.http4s.dsl.io._, scala.concurrent.ExecutionContext.Implicits.global
    import distage._
    
    object HomeRouteModule extends ModuleDef {
      many[HttpRoutes[IO]].add {
        HttpRoutes.of[IO] { case GET -> Root / "home" => Ok(s"Home page!") }
      }
    }

    Set bindings defined in different modules will be merged together into a single Set. You can summon a created Set by type Set[T]:

    import cats.implicits._, org.http4s.server.blaze._, org.http4s.implicits._
    
    object BlogRouteModule extends ModuleDef {
      many[HttpRoutes[IO]].add {
        HttpRoutes.of[IO] { case GET -> Root / "blog" / post => Ok("Blog post ``$post''!") }
      }
    }
    
    class HttpServer(routes: Set[HttpRoutes[IO]]) {
      val router = routes.foldK
    
      def serve = BlazeBuilder[IO]
        .bindHttp(8080, "localhost")
        .mountService(router, "/")
        .start
    }
    
    val objects = Injector().produce(HomeRouteModule ++ BlogRouteModule)
    val server = objects.get[HttpServer]
    
    val testRouter = server.router.orNotFound
    
    testRouter.run(Request[IO](uri = uri("/home"))).flatMap(_.as[String]).unsafeRunSync
    // Home page!
    
    testRouter.run(Request[IO](uri = uri("/blog/1"))).flatMap(_.as[String]).unsafeRunSync
    // Blog post ``1''!
    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
    See also

    Guice wiki on Multibindings: https://github.com/google/guice/wiki/Multibindings

  30. final def modify[T]: ModifyDSL[T, MakeDSL, MakeDSLUnnamedAfterFrom, SetDSL]

    Modify a value bound at T.

    Modify a value bound at T. Modifiers stack and are all applied before T is added to the object graph; only the final instance is observable.

    import distage.{Injector, ModuleDef}
    
    Injector().produceGet[Int](new ModuleDef {
      make[Int].from(1)
      modify[Int](_ + 1)
      modify[Int](_ + 1)
    }).use(i => println(s"Got `Int` $i"))
    // Got `Int` 3

    You can also modify while summoning additional dependencies:

    modify[Int]("named").by(_.flatAp {
      (adder: Adder, multiplier: Multiplier) =>
        int: Int =>
          multiplier.multiply(adder.add(int, 1), 10)
    })
    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
  31. implicit final lazy val mutationContext: MutationContext
    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. final def tag(tags: BindingTag*): Unit

    Add tags to all bindings in this module, except for included bindings

    Add tags to all bindings in this module, except for included bindings

    Attributes
    protected
    Definition Classes
    TagsDSL
  37. final def toString(): String
    Definition Classes
    ModuleBase → AnyRef → Any
  38. final def todo[T](implicit arg0: Tag[T], pos: CodePositionMaterializer): MakeDSLUnnamedAfterFrom[T]

    Create a dummy binding that throws an exception with an error message when it's created.

    Create a dummy binding that throws an exception with an error message when it's created.

    Useful for prototyping.

    Attributes
    protected
    Definition Classes
    AbstractBindingDefDSL
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. final def includeApplyTags(that: ModuleBase): Unit
    Attributes
    protected
    Definition Classes
    IncludesDSL
    Annotations
    @deprecated
    Deprecated

    (Since version 1.2.9) Outer module's tags are now added to included module by default, use regular include

Inherited from ModuleDef

Inherited from ModuleDefDSL

Inherited from TagsDSL

Inherited from IncludesDSL

Inherited from Module

Inherited from ModuleBase

Inherited from CachedHashcode

Inherited from AnyRef

Inherited from Any

Ungrouped