Struct dagger_sdk::Module

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

Fields

proc: Option<Arc<DaggerSessionProc>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl Module

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

Modules used by this module.

pub fn dependency_config(&self) -> Vec<ModuleDependency>

The dependencies as configured by the module.

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

The doc string of the module, if any

pub fn enums(&self) -> Vec<TypeDef>

Enumerations served by this module.

pub fn generated_context_diff(&self) -> Directory

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

pub fn generated_context_directory(&self) -> Directory

The module source’s context plus any configuration and source files created by codegen.

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

A unique identifier for this Module.

pub fn initialize(&self) -> Module

Retrieves the module with the objects loaded via its SDK.

pub fn interfaces(&self) -> Vec<TypeDef>

Interfaces served by this module.

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

The name of the module

pub fn objects(&self) -> Vec<TypeDef>

Objects served by this module.

pub fn runtime(&self) -> Container

The container that runs the module’s entrypoint. It will fail to execute if the module doesn’t compile.

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

The SDK used by this module. Either a name of a builtin SDK or a module source ref string pointing to the SDK’s implementation.

pub async fn serve(&self) -> Result<Void, DaggerError>

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.

pub fn source(&self) -> ModuleSource

The source for the module.

pub fn with_description(&self, description: impl Into<String>) -> Module

Retrieves the module with the given description

Arguments

• description - The description to set

pub fn with_enum(&self, enum: impl IntoID<TypeDefId>) -> Module

This module plus the given Enum type and associated values

pub fn with_interface(&self, iface: impl IntoID<TypeDefId>) -> Module

This module plus the given Interface type and associated functions

pub fn with_object(&self, object: impl IntoID<TypeDefId>) -> Module

This module plus the given Object type and associated functions.

pub fn with_source(&self, source: impl IntoID<ModuleSourceId>) -> Module

Retrieves the module with basic configuration loaded if present.

Arguments

• source - The module source to initialize from.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_source_opts<'a>( &self, source: impl IntoID<ModuleSourceId>, opts: ModuleWithSourceOpts<'a>, ) -> Module

Retrieves the module with basic configuration loaded if present.

Arguments

• source - The module source to initialize from.
• opt - optional argument, see inner type for documentation, use _opts to use

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IntoID<ModuleId> for Module

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