View Source Dagger.ModuleRef (dagger v0.9.11)

A reference to a module.

Link to this section Summary

Functions

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

String representation of the ref.

A unique identifier for this ModuleRef.

The path to the module source code dir specified by this ref.

Link to this section Types

@type t() :: %Dagger.ModuleRef{client: term(), selection: term()}

Link to this section Functions

@spec as_git_ref(t()) :: {:ok, Dagger.GitModuleRef.t() | nil} | {:error, term()}
Link to this function

as_local_ref(module_ref)

View Source
@spec as_local_ref(t()) :: {:ok, Dagger.LocalModuleRef.t() | nil} | {:error, term()}
@spec as_module(t()) :: Dagger.Module.t()

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

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

String representation of the ref.

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

A unique identifier for this ModuleRef.

@spec kind(t()) :: {:ok, Dagger.ModuleRefKind.t()} | {:error, term()}
Link to this function

module_source_path(module_ref)

View Source
@spec module_source_path(t()) :: {:ok, Dagger.String.t()} | {:error, term()}

The path to the module source code dir specified by this ref.