dagger/dsl/module_source · dagger_gleam

as_module

pub fn as_module(parent: types.ModuleSource) -> types.Module

Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation

as_string

</>

pub fn as_string(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

A human readable ref string representation of this module source.

blueprint

</>

pub fn blueprint(
  parent: types.ModuleSource,
) -> types.ModuleSource

The blueprint referenced by the module source.

clone_ref

</>

pub fn clone_ref(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The ref to clone the root of the git repo from. Only valid for git sources.

commit

</>

pub fn commit(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The resolved commit of the git repo this source points to.

config_exists

</>

pub fn config_exists(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(Bool, types.QueryError)) -> a,
) -> a

Whether an existing dagger.json for the module was found.

context_directory

</>

pub fn context_directory(
  parent: types.ModuleSource,
) -> types.Directory

The full directory loaded for the module source, including the source code as a subdirectory.

digest

</>

pub fn digest(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

A content-hash of the module source. Module sources with the same digest will output the same generated context and convert into the same module instance.

generated_context_directory

</>

pub fn generated_context_directory(
  parent: types.ModuleSource,
) -> types.Directory

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

html_repo_u_r_l

</>

pub fn html_repo_u_r_l(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket).

html_u_r_l

</>

pub fn html_u_r_l(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The URL to the source’s git repo in a web browser. Only valid for git sources.

id

</>

pub fn id(parent: types.ModuleSource) -> types.ModuleSource

A unique identifier for this ModuleSource.

introspection_schema_j_s_o_n

</>

pub fn introspection_schema_j_s_o_n(
  parent: types.ModuleSource,
) -> types.File

The introspection schema JSON file for this module source. This file represents the schema visible to the module’s source code, including all core types and those from the dependencies. Note: this is in the context of a module, so some core types may be hidden.

kind

</>

pub fn kind(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(
    Result(types.ModuleSourceKind, types.QueryError),
  ) -> a,
) -> a

The kind of module source (currently local, git or dir).

local_context_directory_path

</>

pub fn local_context_directory_path(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The full absolute path to the context directory on the caller’s host filesystem that this module source is loaded from. Only valid for local module sources.

module_name

</>

pub fn module_name(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The name of the module, including any setting via the withName API.

module_original_name

</>

pub fn module_original_name(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The original name of the module as read from the module’s dagger.json (or set for the first time with the withName API).

module_source

</>

pub fn module_source(
  id id: types.ModuleSource,
) -> types.ModuleSource

original_subpath

</>

pub fn original_subpath(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The original subpath used when instantiating this module source, relative to the context directory.

pin

</>

pub fn pin(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The pinned version of this module source.

repo_root_path

</>

pub fn repo_root_path(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The import path corresponding to the root of the git repo this source points to. Only valid for git sources.

sdk

</>

pub fn sdk(parent: types.ModuleSource) -> types.SDKConfig

The SDK configuration of the module.

source_root_subpath

</>

pub fn source_root_subpath(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The path, relative to the context directory, that contains the module’s dagger.json.

source_subpath

</>

pub fn source_subpath(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The path to the directory containing the module’s source code, relative to the context directory.

sync

</>

pub fn sync(parent: types.ModuleSource) -> types.ModuleSource

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

toolchains

</>

pub fn toolchains(
  parent: types.ModuleSource,
  select select: fn(types.ModuleSource) -> List(types.Field),
  client client: types.Client,
  then handler: fn(
    Result(List(types.ModuleSource), types.QueryError),
  ) -> a,
) -> a

The toolchains referenced by the module source.

user_defaults

</>

pub fn user_defaults(parent: types.ModuleSource) -> types.EnvFile

User-defined defaults read from local .env files

version

</>

pub fn version(
  parent: types.ModuleSource,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

The specified version of the git repo this source points to.

with_blueprint

</>

pub fn with_blueprint(
  parent: types.ModuleSource,
  blueprint blueprint: types.ModuleSource,
) -> types.ModuleSource

Set a blueprint for the module source.

with_client

</>

pub fn with_client(
  parent: types.ModuleSource,
  generator generator: String,
  output_dir output_dir: String,
) -> types.ModuleSource

Update the module source with a new client to generate.

with_dependencies

</>

pub fn with_dependencies(
  parent: types.ModuleSource,
  dependencies dependencies: List(types.ModuleSource),
) -> types.ModuleSource

Append the provided dependencies to the module source’s dependency list.

with_engine_version

</>

pub fn with_engine_version(
  parent: types.ModuleSource,
  version version: String,
) -> types.ModuleSource

Upgrade the engine version of the module to the given value.

with_experimental_features

</>

pub fn with_experimental_features(
  parent: types.ModuleSource,
  features features: List(types.ModuleSourceExperimentalFeature),
) -> types.ModuleSource

Enable the experimental features for the module source.

with_includes

</>

pub fn with_includes(
  parent: types.ModuleSource,
  patterns patterns: List(String),
) -> types.ModuleSource

Update the module source with additional include patterns for files+directories from its context that are required for building it

with_name

</>

pub fn with_name(
  parent: types.ModuleSource,
  name name: String,
) -> types.ModuleSource

Update the module source with a new name.

with_s_d_k

</>

pub fn with_s_d_k(
  parent: types.ModuleSource,
  source source: String,
) -> types.ModuleSource

Update the module source with a new SDK.

with_source_subpath

</>

pub fn with_source_subpath(
  parent: types.ModuleSource,
  path path: String,
) -> types.ModuleSource

Update the module source with a new source subpath.

with_toolchains

</>

pub fn with_toolchains(
  parent: types.ModuleSource,
  toolchains toolchains: List(types.ModuleSource),
) -> types.ModuleSource

Add toolchains to the module source.

with_update_blueprint

</>

pub fn with_update_blueprint(
  parent: types.ModuleSource,
) -> types.ModuleSource

Update the blueprint module to the latest version.

with_update_dependencies

</>

pub fn with_update_dependencies(
  parent: types.ModuleSource,
  dependencies dependencies: List(String),
) -> types.ModuleSource

Update one or more module dependencies.

with_update_toolchains

</>

pub fn with_update_toolchains(
  parent: types.ModuleSource,
  toolchains toolchains: List(String),
) -> types.ModuleSource

Update one or more toolchains.

with_updated_clients

</>

pub fn with_updated_clients(
  parent: types.ModuleSource,
  clients clients: List(String),
) -> types.ModuleSource

Update one or more clients.

without_blueprint

</>

pub fn without_blueprint(
  parent: types.ModuleSource,
) -> types.ModuleSource

Remove the current blueprint from the module source.

without_client

</>

pub fn without_client(
  parent: types.ModuleSource,
  path path: String,
) -> types.ModuleSource

Remove a client from the module source.

without_dependencies

</>

pub fn without_dependencies(
  parent: types.ModuleSource,
  dependencies dependencies: List(String),
) -> types.ModuleSource

Remove the provided dependencies from the module source’s dependency list.

without_experimental_features

</>

pub fn without_experimental_features(
  parent: types.ModuleSource,
  features features: List(types.ModuleSourceExperimentalFeature),
) -> types.ModuleSource

Disable experimental features for the module source.

without_toolchains

</>

pub fn without_toolchains(
  parent: types.ModuleSource,
  toolchains toolchains: List(String),
) -> types.ModuleSource

Remove the provided toolchains from the module source.