microsite
API
Generated with
microsite/izumi/izumi.distage/izumi.distage.model

izumi.distage.model

package izumi.distage.model

Members list

Packages

package izumi.distage.model.definition
package izumi.distage.model.exceptions
package izumi.distage.model.plan
package izumi.distage.model.planning
package izumi.distage.model.providers
package izumi.distage.model.provisioning
package izumi.distage.model.recursive
package izumi.distage.model.references
package izumi.distage.model.reflection

Type members

Classlikes

trait Injector[F[_]] extends Planner, Producer

Injector creates object graphs (izumi.distage.model.Locators) from a izumi.distage.model.definition.ModuleDef or from an izumi.distage.model.plan.Plan

Injector creates object graphs (izumi.distage.model.Locators) from a izumi.distage.model.definition.ModuleDef or from an izumi.distage.model.plan.Plan

Attributes

See also
Companion
object
Supertypes
trait Producer
trait Planner
class Object
trait Matchable
class Any
Known subtypes
object Injector extends InjectorFactory

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Injector.type
final case class InjectorProvidedEnv(injectorFactory: InjectorFactory, bootstrapModule: BootstrapModule, bootstrapLocator: Locator, defaultModule: Module, planner: Planner, interpreter: PlanInterpreter)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait Locator

The object graph created by executing a plan. Can be queried for contained objects.

The object graph created by executing a plan. Can be queried for contained objects.

Attributes

See also
Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait LocatorDef
object Locator

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Locator.type
trait Planner

Transforms izumi.distage.model.definition.ModuleDef into izumi.distage.model.plan.Plan

Transforms izumi.distage.model.definition.ModuleDef into izumi.distage.model.plan.Plan

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Injector[F]
object PlannerInput

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PlannerInput(bindings: ModuleBase, roots: Roots, activation: Activation, locatorPrivacy: LocatorPrivacy)

Input for Planner

Input for Planner

Value parameters

bindings

Bindings. Can be created using izumi.distage.model.definition.ModuleDef DSL

roots

Garbage collection roots. distage will ignore all bindings that aren't transitive dependencies of the chosen Root keys from the plan - they will never be instantiated. Effectively, the choice of roots selects a sub-graph of the largest possible object graph that can be described by bindings - the sub-graph that only includes components designated as roots and their transitive dependencies. On izumi.distage.model.plan.Roots.Everything garbage collection will not be performed – that would be equivalent to designating all DIKeys as roots.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait Producer

Executes instructions in izumi.distage.model.plan.Plan to produce a izumi.distage.model.Locator

Executes instructions in izumi.distage.model.plan.Plan to produce a izumi.distage.model.Locator

Attributes

Throws
izumi.distage.model.exceptions.runtime.ProvisioningException

produce* methods raise this exception in F effect type on failure

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Injector[F]
Generated with