Struct ModuleSource

pub struct ModuleSource {
    pub proc: Option<Arc<DaggerSessionProc>>,
    pub selection: Selection,
    pub graphql_client: DynGraphQLClient,
}

Fields

proc: Option<Arc<DaggerSessionProc>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl ModuleSource

pub fn as_module(&self) -> Module

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

pub async fn as_string(&self) -> Result<String, DaggerError>

A human readable ref string representation of this module source.

pub fn blueprint(&self) -> ModuleSource

The blueprint referenced by the module source.

pub async fn clone_ref(&self) -> Result<String, DaggerError>

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

pub async fn commit(&self) -> Result<String, DaggerError>

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

pub fn config_clients(&self) -> Vec<ModuleConfigClient>

The clients generated for the module.

pub async fn config_exists(&self) -> Result<bool, DaggerError>

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

pub fn context_directory(&self) -> Directory

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

pub fn dependencies(&self) -> Vec<ModuleSource>

The dependencies of the module source.

pub async fn digest(&self) -> Result<String, DaggerError>

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.

pub fn directory(&self, path: impl Into<String>) -> Directory

The directory containing the module configuration and source code (source code may be in a subdir).

Arguments

• path - A subpath from the source directory to select.

pub async fn engine_version(&self) -> Result<String, DaggerError>

The engine version of the module.

pub fn generated_context_directory(&self) -> Directory

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

pub async fn html_repo_url(&self) -> Result<String, DaggerError>

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

pub async fn html_url(&self) -> Result<String, DaggerError>

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

pub async fn id(&self) -> Result<ModuleSourceId, DaggerError>

A unique identifier for this ModuleSource.

pub async fn kind(&self) -> Result<ModuleSourceKind, DaggerError>

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

pub async fn local_context_directory_path(&self) -> Result<String, DaggerError>

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.

pub async fn module_name(&self) -> Result<String, DaggerError>

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

pub async fn module_original_name(&self) -> Result<String, DaggerError>

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

pub async fn original_subpath(&self) -> Result<String, DaggerError>

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

pub async fn pin(&self) -> Result<String, DaggerError>

The pinned version of this module source.

pub async fn repo_root_path(&self) -> Result<String, DaggerError>

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

pub fn sdk(&self) -> SdkConfig

The SDK configuration of the module.

pub async fn source_root_subpath(&self) -> Result<String, DaggerError>

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

pub async fn source_subpath(&self) -> Result<String, DaggerError>

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

pub async fn sync(&self) -> Result<ModuleSourceId, DaggerError>

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

pub async fn version(&self) -> Result<String, DaggerError>

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

pub fn with_blueprint( &self, blueprint: impl IntoID<ModuleSourceId>, ) -> ModuleSource

Set a blueprint for the module source.

Arguments

• blueprint - The blueprint module to set.

pub fn with_client( &self, generator: impl Into<String>, output_dir: impl Into<String>, ) -> ModuleSource

Update the module source with a new client to generate.

Arguments

• generator - The generator to use
• output_dir - The output directory for the generated client.

pub fn with_dependencies( &self, dependencies: Vec<ModuleSourceId>, ) -> ModuleSource

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

Arguments

• dependencies - The dependencies to append.

pub fn with_engine_version(&self, version: impl Into<String>) -> ModuleSource

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

Arguments

• version - The engine version to upgrade to.

pub fn with_includes(&self, patterns: Vec<impl Into<String>>) -> ModuleSource

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

Arguments

• patterns - The new additional include patterns.

pub fn with_name(&self, name: impl Into<String>) -> ModuleSource

Update the module source with a new name.

Arguments

• name - The name to set.

pub fn with_sdk(&self, source: impl Into<String>) -> ModuleSource

Update the module source with a new SDK.

Arguments

• source - The SDK source to set.

pub fn with_source_subpath(&self, path: impl Into<String>) -> ModuleSource

Update the module source with a new source subpath.

Arguments

• path - The path to set as the source subpath. Must be relative to the module source’s source root directory.

pub fn with_update_blueprint(&self) -> ModuleSource

Update the blueprint module to the latest version.

pub fn with_update_dependencies( &self, dependencies: Vec<impl Into<String>>, ) -> ModuleSource

Update one or more module dependencies.

Arguments

• dependencies - The dependencies to update.

pub fn without_blueprint(&self) -> ModuleSource

Remove the current blueprint from the module source.

pub fn without_client(&self, path: impl Into<String>) -> ModuleSource

Remove a client from the module source.

Arguments

• path - The path of the client to remove.

pub fn without_dependencies( &self, dependencies: Vec<impl Into<String>>, ) -> ModuleSource

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

Arguments

• dependencies - The dependencies to remove.

Trait Implementations

impl Clone for ModuleSource

fn clone(&self) -> ModuleSource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl IntoID<ModuleSourceId> for ModuleSource

fn into_id( self, ) -> Pin<Box<dyn Future<Output = Result<ModuleSourceId, DaggerError>> + Send>>