izumi.distage.framework.services

Members list

Concise view

Type members

Classlikes

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Impl

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
class BootstrapPlatformModule(options: PlanningOptions) extends BootstrapModuleDef

Attributes

Graph
Supertypes
trait BootstrapModuleDef
trait ModuleDefDSL
trait TagsDSL
trait IncludesDSL
trait AbstractBindingDefDSL[MakeDSL, MakeDSLUnnamedAfterFrom, SetDSL]
trait AbstractBindingDefDSLMacro[MakeDSL]
trait BootstrapModule
trait ModuleBase
trait CachedHashcode
class Object
trait Matchable
class Any

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Default
object Empty.type

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Default config resources:

Default config resources:

  • ${roleName}.conf
  • ${roleName}-reference.conf
  • ${roleName}-reference-dev.conf
  • application.conf
  • application-reference.conf
  • application-reference-dev.conf
  • common.conf
  • common-reference.conf
  • common-reference-dev.conf

NOTE: You can change default config locations by overriding make[ConfigLocation] binding in izumi.distage.roles.RoleAppMain#roleAppBootOverrides (defaults defined in izumi.distage.roles.RoleAppBootModule)

When explicit configs are passed to the role launcher on the command-line using the -c option, they have higher priority than all the reference configs. Role-specific configs on the command-line (-c option after :role argument) override global command-line configs (-c option given before the first :role argument).

Example:

 ./launcher -c global.conf :role1 -c role1.conf :role2 -c role2.conf

Here configs will be loaded in the following order, with higher priority earlier:

  • explicits: role1.conf, role2.conf, global.conf,
  • resources: role1[-reference,-dev].conf, role2[-reference,-dev].conf, ,application[-reference,-dev].conf, common[-reference,-dev].conf

Attributes

See also:

ConfigLoader.ConfigLocation

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Default.type

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

This component is responsible for passing-through selected components from the outer izumi.distage.roles.RoleAppBootModule context into DI scope of the started application.

This component is responsible for passing-through selected components from the outer izumi.distage.roles.RoleAppBootModule context into DI scope of the started application.

The application doesn't outright inherit the outer context because that would bring in way too many unrelated components into scope.

This will also add some other useful components:

  • GraphViz dump hook will be enabled if PlanningOptions#addGraphVizDump is enabled (via --debug-dump-graph commandline parameter)
  • IzLogger will be passed in from the outer context
  • LogIO[F] will be available with the application's effect type
  • LocatorRef @Id("roleapp") allows accessing components from outer context if needed

Attributes

See also:
Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Impl[F]
Self type

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
class PlanCircularDependencyCheck(options: PlanningOptions, logger: IzLogger)

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
class ResourceRewriter(logger: IzLogger, rules: RewriteRules) extends PlanningHook

Rewrites bindings implemented with _ <: AutoCloseable into resource bindings that automatically close the implementation closeable.

Rewrites bindings implemented with _ <: AutoCloseable into resource bindings that automatically close the implementation closeable.

 class XImpl extends AutoCloseable
 make[X].from[XImpl]

becomes:

 make[X].fromResource {
  ClassConstructor[XImpl].map(distage.Lifecycle.fromAutoCloseable(_))
 }

Will produce warnings for all rewritten bindings, so better explicitly use .fromResource!

Attributes

Companion:
object
Graph
Supertypes
trait PlanningHook
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Impl[F]

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type