View Source Dagger.Module (dagger v0.9.3)

Module

Link to this section Summary

Functions

Modules used by this module

The dependencies as configured by the module

The doc string of the module, if any

The code generated by the SDK's runtime

The ID of the module

The name of the module

Objects served by this module

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

Serve a module's API in the current session.

The directory containing the module's source code

The module's subpath within the source directory

This module plus the given Object type and associated functions

Link to this section Types

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

Link to this section Functions

@spec dependencies(t()) :: {:ok, [t()]} | {:error, term()}

Modules used by this module

Link to this function

dependency_config(module)

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

The dependencies as configured by the module

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

The doc string of the module, if any

@spec generated_code(t()) :: Dagger.GeneratedCode.t()

The code generated by the SDK's runtime

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

The ID of the module

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

The name of the module

@spec objects(t()) :: {:ok, [Dagger.TypeDef.t()] | nil} | {:error, term()}

Objects served by this module

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

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

@spec serve(t()) :: {:ok, Dagger.Void.t() | nil} | {:error, term()}

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.
Link to this function

source_directory(module)

View Source
@spec source_directory(t()) :: Dagger.Directory.t()

The directory containing the module's source code

Link to this function

source_directory_sub_path(module)

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

The module's subpath within the source directory

Link to this function

with_object(module, object)

View Source
@spec with_object(t(), Dagger.TypeDef.t()) :: t()

This module plus the given Object type and associated functions

required-arguments

Required Arguments

  • object -