trait Injector[F[_]] extends Planner with Producer
Injector creates object graphs (izumi.distage.model.Locators) from a izumi.distage.model.definition.ModuleDef or from an izumi.distage.model.plan.Plan
- Alphabetic
- By Inheritance
- Injector
- Producer
- Planner
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- implicit abstract def F: QuasiIO[F]
- Attributes
- protected
- abstract def plan(input: PlannerInput): Either[NEList[DIError], Plan]
- Definition Classes
- Planner
- abstract def planNoRewrite(input: PlannerInput): Either[NEList[DIError], Plan]
Does the same job as plan() but does not apply any binding rewrites (autocloseables, resources, etc) Most likely you won't need to call this method directly.
Does the same job as plan() but does not apply any binding rewrites (autocloseables, resources, etc) Most likely you won't need to call this method directly.
- Definition Classes
- Planner
- abstract def providedEnvironment: InjectorProvidedEnv
- abstract def providedKeys: Set[DIKey]
Keys that will be available to the module interpreted by this Injector, includes parent Locator keys, izumi.distage.modules.DefaultModule & Injector's self-reference keys
- abstract def rewrite(bindings: ModuleBase): ModuleBase
- Definition Classes
- Planner
- implicit abstract def tagK: TagK[F]
- Attributes
- protected
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 assert(bindings: ModuleBase, roots: Roots, excludedActivations: Set[NESet[AxisChoice]] = Set.empty): Unit
Efficiently check all possible paths for the given module to the given
roots
,Efficiently check all possible paths for the given module to the given
roots
,This is a "raw" version of izumi.distage.framework.PlanCheck API, please use
PlanCheck
for all non-exotic needs.This method executes at runtime, to check correctness at compile-time use
PlanCheck
API fromdistage-framework
module.- returns
Unit
- Exceptions thrown
PlanCheckException
on found issues- See also
- 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 getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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 plan(bindings: ModuleBase, roots: Roots, activation: Activation = Activation.empty, locatorPrivacy: LocatorPrivacy = LocatorPrivacy.PublicByDefault): Either[NEList[DIError], Plan]
- Definition Classes
- Planner
- Annotations
- @inline()
- final def produce(plan: Plan): Lifecycle[F, Locator]
Create an effectful izumi.distage.model.definition.Lifecycle value that encapsulates the allocation and cleanup of an object graph described by an existing
plan
Create an effectful izumi.distage.model.definition.Lifecycle value that encapsulates the allocation and cleanup of an object graph described by an existing
plan
class HelloWorld { def hello() = println("hello world") } val injector = Injector() val plan = injector.plan(PlannerInput( bindings = new ModuleDef { make[HelloWorld] }, activation = Activation.empty, roots = Roots.target[HelloWorld], )).getOrThrow() injector .produce(plan) .use(_.get[HelloWorld].hello())
- plan
Computed wiring plan, may be produced by calling the plan method
- returns
A Resource value that encapsulates allocation and cleanup of the object graph described by
input
- final def produce(bindings: ModuleBase, roots: Roots, activation: Activation = Activation.empty, locatorPrivacy: LocatorPrivacy = LocatorPrivacy.PublicByDefault): Lifecycle[F, Locator]
- final def produce(input: PlannerInput): Lifecycle[F, Locator]
Create an effectful izumi.distage.model.definition.Lifecycle value that encapsulates the allocation and cleanup of an object graph described by
input
Create an effectful izumi.distage.model.definition.Lifecycle value that encapsulates the allocation and cleanup of an object graph described by
input
class HelloWorld { def hello() = println("hello world") } Injector() .produce(PlannerInput( bindings = new ModuleDef { make[HelloWorld] }, activation = Activation.empty, roots = Roots.target[HelloWorld], )) .use(_.get[HelloWorld].hello())
- input
Bindings created by izumi.distage.model.definition.ModuleDef DSL and garbage collection roots. Garbage collector will remove all bindings that aren't direct or indirect dependencies of the chosen
root
DIKeys from the plan - they will never be instantiated. If left empty, garbage collection will not be performed – that would be equivalent to designating all DIKeys as roots.- returns
A Resource value that encapsulates allocation and cleanup of the object graph described by
input
- final def produceCustomF[G[_]](input: PlannerInput)(implicit arg0: TagK[G], G: QuasiIO[G]): Lifecycle[G, Locator]
Produce izumi.distage.model.Locator interpreting effect and resource bindings into the provided effect type
- final def produceCustomF[F[_]](plan: Plan)(implicit arg0: TagK[F], arg1: QuasiIO[F]): Lifecycle[F, Locator]
Produce izumi.distage.model.Locator interpreting effect- and resource-bindings into the provided
F
Produce izumi.distage.model.Locator interpreting effect- and resource-bindings into the provided
F
- Definition Classes
- Producer
- final def produceCustomIdentity(input: PlannerInput): Lifecycle[Identity, Locator]
Produce izumi.distage.model.Locator, supporting only effect and resource bindings in
Identity
- final def produceCustomIdentity(plan: Plan): Lifecycle[Identity, Locator]
Produce izumi.distage.model.Locator, supporting only effect- and resource-bindings in
Identity
Produce izumi.distage.model.Locator, supporting only effect- and resource-bindings in
Identity
- Definition Classes
- Producer
- final def produceDetailedCustomF[G[_]](input: PlannerInput)(implicit arg0: TagK[G], G: QuasiIO[G]): Lifecycle[G, Either[FailedProvision, Locator]]
- final def produceDetailedCustomF[F[_]](plan: Plan)(implicit arg0: TagK[F], arg1: QuasiIO[F]): Lifecycle[F, Either[FailedProvision, Locator]]
- Definition Classes
- Producer
- final def produceDetailedIdentity(input: PlannerInput): Lifecycle[Identity, Either[FailedProvision, Locator]]
- final def produceDetailedIdentity(plan: Plan): Lifecycle[Identity, Either[FailedProvision, Locator]]
- Definition Classes
- Producer
- final def produceEval[A](bindings: ModuleBase, activation: Activation = Activation.empty)(function: Functoid[F[A]]): Lifecycle[F, A]
Create an effectful izumi.distage.model.definition.Lifecycle value that encapsulates the allocation and cleanup of an object graph described by the
input
module, designate all arguments of the provided function as roots of the graph and run the function.Create an effectful izumi.distage.model.definition.Lifecycle value that encapsulates the allocation and cleanup of an object graph described by the
input
module, designate all arguments of the provided function as roots of the graph and run the function.class Hello { def hello() = println("hello") } class World { def world() = println("world") } Injector() .produceEval(new ModuleDef { make[Hello] make[World] }) { (hello: Hello, world: World) => hello.hello() world } .use { world => world.world() }
This is useful for the common case when you want to run an effect using the produced objects from the object graph, without finalizing the object graph yet
Injector[F]().produceEval[A](moduleDef)(fn)
is a short-hand for:Injector[F]() .produce(moduleDef, Roots(fn.get.diKeys.toSet)) .evalMap(_.run(fn)): Lifecycle[F, A]
- bindings
Bindings created by izumi.distage.model.definition.ModuleDef DSL
- activation
A map of axes of configuration to choices along these axes
- function
N-ary izumi.distage.model.providers.Functoid function for which arguments will be designated as roots and provided from the object graph
- final def produceGet[A](name: Identifier)(bindings: ModuleBase, activation: Activation = Activation.empty)(implicit arg0: Tag[A]): Lifecycle[F, A]
- final def produceGet[A](bindings: ModuleBase)(implicit arg0: Tag[A]): Lifecycle[F, A]
- final def produceGet[A](bindings: ModuleBase, activation: Activation)(implicit arg0: Tag[A]): Lifecycle[F, A]
Create an effectful izumi.distage.model.definition.Lifecycle value that encapsulates the allocation and cleanup of an object graph described by the
input
module, designateA
as the root of the graph and retrieveA
from the result.Create an effectful izumi.distage.model.definition.Lifecycle value that encapsulates the allocation and cleanup of an object graph described by the
input
module, designateA
as the root of the graph and retrieveA
from the result.class HelloWorld { def hello() = println("hello world") } Injector() .produceGet[HelloWorld](new ModuleDef { make[HelloWorld] }) .use(_.hello())
This is useful for the common case when your main logic class is the root of your graph AND the object you want to use immediately.
Injector[F]().produceGet[A](moduleDef)
is a short-hand for:Injector[F]() .produce(moduleDef, Roots(DIKey.get[A])) .map(_.get[A]): Lifecycle[F, A]
- bindings
Bindings created by izumi.distage.model.definition.ModuleDef DSL
- activation
A map of axes of configuration to choices along these axes
- final def produceRun[A](bindings: ModuleBase, activation: Activation = Activation.empty)(function: Functoid[F[A]]): F[A]
Create an an object graph described by the
input
module, designate all arguments of the provided function as roots of the graph, and run the function, deallocating the object graph when the function exits.Create an an object graph described by the
input
module, designate all arguments of the provided function as roots of the graph, and run the function, deallocating the object graph when the function exits.class Hello { def hello() = println("hello") } class World { def world() = println("world") } Injector() .produceRun(new ModuleDef { make[Hello] make[World] }) { (hello: Hello, world: World) => hello.hello() world.world() }
This is useful for the common case when you want to run an effect using the produced objects from the object graph and deallocate the object graph once the effect is finished
Injector[F]().produceRun[A](moduleDef)(fn)
is a short-hand for:Injector[F]() .produce(moduleDef, Roots(fn.get.diKeys.toSet)) .use(_.run(fn)): F[A]
- bindings
Bindings created by izumi.distage.model.definition.ModuleDef DSL
- activation
A map of axes of configuration to choices along these axes
- function
N-ary izumi.distage.model.providers.Functoid function for which arguments will be designated as roots and provided from the object graph
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def verify(bindings: ModuleBase, roots: Roots, excludedActivations: Set[NESet[AxisChoice]] = Set.empty): PlanVerifierResult
Efficiently check all possible paths for the given module to the given
roots
,Efficiently check all possible paths for the given module to the given
roots
,This is a "raw" version of izumi.distage.framework.PlanCheck API, please use
PlanCheck
for all non-exotic needs.This method executes at runtime, to check correctness at compile-time use
PlanCheck
API fromdistage-framework
module.- returns
Set of issues if any.
- Exceptions thrown
Nothing
Does not throw.- See also
- 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()
Deprecated Value Members
- final def planUnsafe(input: PlannerInput): Plan
- Definition Classes
- Planner
- Deprecated
Use
.plan(input).getOrThrow()