View Source Dagger.InterfaceTypeDef (dagger v0.10.0)

A definition of a custom interface defined in a Module.

Link to this section Summary

Functions

The doc string for the interface, if any.

Functions defined on this interface, if any.

A unique identifier for this InterfaceTypeDef.

The name of the interface.

If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.

Link to this section Types

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

Link to this section Functions

Link to this function

description(interface_type_def)

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

The doc string for the interface, if any.

Link to this function

functions(interface_type_def)

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

Functions defined on this interface, if any.

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

A unique identifier for this InterfaceTypeDef.

Link to this function

name(interface_type_def)

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

The name of the interface.

Link to this function

source_module_name(interface_type_def)

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

If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.