View Source Dagger.Module (dagger v0.17.0)
A Dagger module.
Summary
Functions
The dependencies of the module.
The doc string of the module, if any
Enumerations served by this module.
The generated files and directories made on top of the module source's context directory.
A unique identifier for this Module.
Interfaces served by this module.
The name of the module
Objects served by this module.
The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
The SDK config used by this module.
Serve a module's API in the current session.
The source for the module.
Forces evaluation of the module, including any loading into the engine and associated validation.
Retrieves the module with the given description
This module plus the given Enum type and associated values
This module plus the given Interface type and associated functions
This module plus the given Object type and associated functions.
Types
Functions
The dependencies of the module.
The doc string of the module, if any
@spec enums(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}
Enumerations served by this module.
@spec generated_context_directory(t()) :: Dagger.Directory.t()
The generated files and directories made on top of the module source's context directory.
@spec id(t()) :: {:ok, Dagger.ModuleID.t()} | {:error, term()}
A unique identifier for this Module.
@spec interfaces(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}
Interfaces served by this module.
The name of the module
@spec objects(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}
Objects served by this module.
@spec runtime(t()) :: Dagger.Container.t()
The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
@spec sdk(t()) :: Dagger.SDKConfig.t() | nil
The SDK config used by this module.
Serve a module's API in the current session.
Note: this can only be called once per session. In the future, it could return a stream or service to remove the side effect.
@spec source(t()) :: Dagger.ModuleSource.t()
The source for the module.
Forces evaluation of the module, including any loading into the engine and associated validation.
Retrieves the module with the given description
@spec with_enum(t(), Dagger.TypeDef.t()) :: t()
This module plus the given Enum type and associated values
@spec with_interface(t(), Dagger.TypeDef.t()) :: t()
This module plus the given Interface type and associated functions
@spec with_object(t(), Dagger.TypeDef.t()) :: t()
This module plus the given Object type and associated functions.