Struct 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 check(&self, name: impl Into<String>) -> Check

Return the check defined by the module with the given name. Must match to exactly one check.

Arguments

• name - The name of the check to retrieve

pub fn checks(&self) -> CheckGroup

Return all checks defined by the module

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn checks_opts<'a>(&self, opts: ModuleChecksOpts<'a>) -> CheckGroup

Return all checks defined by the module

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn dependencies(&self) -> Result<Vec<Module>, DaggerError>

The dependencies of the module.

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

The doc string of the module, if any

pub async fn enums(&self) -> Result<Vec<TypeDef>, DaggerError>

Enumerations served by this module.

pub fn generated_context_directory(&self) -> Directory

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

pub fn generator(&self, name: impl Into<String>) -> Generator

Return the generator defined by the module with the given name. Must match to exactly one generator.

Arguments

• name - The name of the generator to retrieve

pub fn generators(&self) -> GeneratorGroup

Return all generators defined by the module

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn generators_opts<'a>( &self, opts: ModuleGeneratorsOpts<'a>, ) -> GeneratorGroup

Return all generators defined by the module

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

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

A unique identifier for this Module.

pub async fn interfaces(&self) -> Result<Vec<TypeDef>, DaggerError>

Interfaces served by this module.

pub fn introspection_schema_json(&self) -> File

The introspection schema JSON file for this module. 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.

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

The name of the module

pub async fn objects(&self) -> Result<Vec<TypeDef>, DaggerError>

Objects served by this module.

pub async fn runtime(&self) -> Result<Option<Container>, DaggerError>

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<Option<SdkConfig>, DaggerError>

The SDK config used by this module.

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.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn serve_opts( &self, opts: ModuleServeOpts, ) -> 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.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn services(&self) -> UpGroup

Return all services defined by the module

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn services_opts<'a>(&self, opts: ModuleServicesOpts<'a>) -> UpGroup

Return all services defined by the module

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn source(&self) -> Result<Option<ModuleSource>, DaggerError>

The source for the module.

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

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

pub fn user_defaults(&self) -> EnvFile

User-defined default values, loaded from local .env files.

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<Id>) -> Module

This module plus the given Enum type and associated values

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

This module plus the given Interface type and associated functions

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

This module plus the given Object type and associated functions.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl IntoID<Id> for Module

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

impl Loadable for Module

fn graphql_type() -> &'static str

The GraphQL type name (e.g. "Container").

fn from_query( proc: Option<Arc<DaggerSessionProc>>, selection: Selection, graphql_client: DynGraphQLClient, ) -> Self

Construct this type from a query selection.

impl Node for Module

fn id(&self) -> impl Future<Output = Result<Id, DaggerError>> + Send

impl Syncer for Module

fn id(&self) -> impl Future<Output = Result<Id, DaggerError>> + Send

fn sync(&self) -> impl Future<Output = Result<Id, DaggerError>> + Send