Packages

c

izumi.distage.model.plan.DIPlan

DIPlanAssertionSyntax

implicit final class DIPlanAssertionSyntax extends AnyVal

Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DIPlanAssertionSyntax
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DIPlanAssertionSyntax(plan: DIPlan)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  6. final def incompatibleEffectType[F[_]](implicit arg0: TagK[F]): Option[NonEmptyList[MonadicOp]]

    Check for any make[_].fromEffect or make[_].fromResource bindings that are incompatible with the passed F.

    Check for any make[_].fromEffect or make[_].fromResource bindings that are incompatible with the passed F.

    An effect is compatible if it's a subtype of F or is a type equivalent to izumi.fundamentals.platform.functional.Identity (e.g. cats.Id)

    F

    effect type to check against

    returns

    a non-empty list of operations incompatible with F if present

  7. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  8. def toString(): String
    Definition Classes
    Any
  9. final def unresolvedImports: Option[NonEmptyList[ImportDependency]]
  10. final def unresolvedImports(ignoredImports: (DIKey) => Boolean = Set.empty): Option[NonEmptyList[ImportDependency]]

    Check for any unresolved dependencies.

    Check for any unresolved dependencies.

    If this returns None then the wiring is generally correct, modulo runtime exceptions in user code, and Injector.produce should succeed.

    However, presence of imports does not *always* mean that a plan is invalid, imports may be fulfilled by a parent Locator, by BootstrapContext, or they may be materialized by a custom izumi.distage.model.provisioning.strategies.ImportStrategy

    returns

    a non-empty list of unresolved imports if present

Deprecated Value Members

  1. final def assertValid[F[_]](ignoredImports: (DIKey) => Boolean = Set.empty)(implicit arg0: QuasiIO[F], arg1: TagK[F]): F[Unit]

    Check for any unresolved dependencies, or for any make[_].fromEffect or make[_].fromResource bindings that are incompatible with the passed F, or for any other issue that would cause Injector.produce to fail

    Check for any unresolved dependencies, or for any make[_].fromEffect or make[_].fromResource bindings that are incompatible with the passed F, or for any other issue that would cause Injector.produce to fail

    If this returns F.unit then the wiring is generally correct, modulo runtime exceptions in user code, and Injector.produce should succeed.

    However, presence of imports does not *always* mean that a plan is invalid, imports may be fulfilled by a parent Locator, by BootstrapContext, or they may be materialized by a custom izumi.distage.model.provisioning.strategies.ImportStrategy

    An effect is compatible if it's a subtype of F or is a type equivalent to izumi.fundamentals.platform.functional.Identity (e.g. cats.Id)

    Will F.fail the effect with izumi.distage.model.exceptions.InvalidPlanException if there are issues.

    F

    effect type to check against

    Annotations
    @deprecated
    Deprecated

    (Since version 20.07.2021) Use distage.Injector#verify

  2. final def assertValidOrThrow[F[_]](ignoredImports: (DIKey) => Boolean = Set.empty)(implicit arg0: TagK[F]): Unit

    Same as assertValid, but throws an izumi.distage.model.exceptions.InvalidPlanException if there are unresolved imports

    Same as assertValid, but throws an izumi.distage.model.exceptions.InvalidPlanException if there are unresolved imports

    Annotations
    @deprecated
    Deprecated

    (Since version 20.07.2021) Use distage.Injector#verify

    Exceptions thrown

    izumi.distage.model.exceptions.InvalidPlanException if there are issues

  3. final def isValid[F[_]](ignoredImports: (DIKey) => Boolean = Set.empty)(implicit arg0: TagK[F]): Option[InvalidPlanException]

    Same as unresolvedImports, but returns a pretty-printed exception if there are unresolved imports

    Same as unresolvedImports, but returns a pretty-printed exception if there are unresolved imports

    Annotations
    @deprecated
    Deprecated

    (Since version 20.07.2021) Use distage.Injector#verify

Inherited from AnyVal

Inherited from Any

Ungrouped