microsite
API
Generated with
microsite/izumi/izumi.distage/izumi.distage.framework/CheckableApp

CheckableApp

izumi.distage.framework.CheckableApp
See theCheckableApp companion object
trait CheckableApp

Represents distage apps that can be checked by izumi.distage.framework.PlanCheck at compile-time. CheckableApp must be inherited in a top-level object to be usable with PlanCheck

Role-based applications automatically inherit from RoleCheckableApp and can be checked out of the box.

Apps assembled directly using distage-core's distage.Injector will need to implement the interface manually, using CoreCheckableApp or CoreCheckableAppSimple

Attributes

See also
Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CoreCheckableApp[F]
class RoleCheckableApp[F]
class RoleAppMain[F]
class LauncherBIO[F]
Show all

Members list

Type members

Types

type AppEffectType[_]

Value members

Abstract methods

def preparePlanCheckInput(selectedRoles: RoleSelection, chosenConfigFile: Option[String]): PlanCheckInput[AppEffectType]
def tagK: Tag[AppEffectType]

Concrete methods

def customCheck(planVerifier: PlanVerifier, excludedActivations: Set[NESet[AxisPoint]], checkConfig: Boolean, planCheckInput: PlanCheckInput[AppEffectType]): PlanVerifierResult

Override this to execute additional arbitrary user-defined checks at compile-time (or runtime via PlanCheck.runtime)

Override this to execute additional arbitrary user-defined checks at compile-time (or runtime via PlanCheck.runtime)

Attributes

Throws
Throwable

You may throw a custom exception if your check error is not describable by izumi.distage.model.planning.PlanIssue

Generated with