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

t()

@type t() :: %Dagger.Module{client: term(), query_builder: term()}

Functions

dependencies(module)

@spec dependencies(t()) :: {:ok, [t()]} | {:error, term()}

The dependencies of the module.

description(module)

@spec description(t()) :: {:ok, String.t()} | {:error, term()}

The doc string of the module, if any

enums(module)

@spec enums(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}

Enumerations served by this module.

generated_context_directory(module)

@spec generated_context_directory(t()) :: Dagger.Directory.t()

The generated files and directories made on top of the module source's context directory.

id(module)

@spec id(t()) :: {:ok, Dagger.ModuleID.t()} | {:error, term()}

A unique identifier for this Module.

interfaces(module)

@spec interfaces(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}

Interfaces served by this module.

name(module)

@spec name(t()) :: {:ok, String.t()} | {:error, term()}

The name of the module

objects(module)

@spec objects(t()) :: {:ok, [Dagger.TypeDef.t()]} | {:error, term()}

Objects served by this module.

runtime(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.

sdk(module)

@spec sdk(t()) :: Dagger.SDKConfig.t() | nil

The SDK config used by this module.

serve(module)

@spec serve(t()) :: :ok | {:error, term()}

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.

source(module)

@spec source(t()) :: Dagger.ModuleSource.t()

The source for the module.

sync(module)

@spec sync(t()) :: {:ok, t()} | {:error, term()}

Forces evaluation of the module, including any loading into the engine and associated validation.

with_description(module, description)

@spec with_description(t(), String.t()) :: t()

Retrieves the module with the given description

with_enum(module, enum)

@spec with_enum(t(), Dagger.TypeDef.t()) :: t()

This module plus the given Enum type and associated values

with_interface(module, iface)

@spec with_interface(t(), Dagger.TypeDef.t()) :: t()

This module plus the given Interface type and associated functions

with_object(module, object)

@spec with_object(t(), Dagger.TypeDef.t()) :: t()

This module plus the given Object type and associated functions.