View Source Dagger.InterfaceTypeDef (dagger v0.14.0)

A definition of a custom interface defined in a Module.

Summary

Types

t()

Functions

description(interface_type_def)

The doc string for the interface, if any.

functions(interface_type_def)

Functions defined on this interface, if any.

id(interface_type_def)

A unique identifier for this InterfaceTypeDef.

name(interface_type_def)

The name of the interface.

source_map(interface_type_def)

The location of this interface declaration.

source_module_name(interface_type_def)

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

Types

Link to this type

t()

View Source 
@type t() :: %Dagger.InterfaceTypeDef{client: term(), query_builder: term()}

Functions

Link to this function

description(interface_type_def)

View Source 
@spec description(t()) :: {:ok, 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.

Link to this function

id(interface_type_def)

View Source 
@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, String.t()} | {:error, term()}

The name of the interface.

Link to this function

source_map(interface_type_def)

View Source 
@spec source_map(t()) :: Dagger.SourceMap.t()

The location of this interface declaration.

Link to this function

source_module_name(interface_type_def)

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

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