Dagger.EnumTypeDef (dagger v0.18.16)

View Source

A definition of a custom enum defined in a Module.

Summary

Types

t()

Functions

description(enum_type_def)

A doc string for the enum, if any.

id(enum_type_def)

A unique identifier for this EnumTypeDef.

members(enum_type_def)

The members of the enum.

name(enum_type_def)

The name of the enum.

source_map(enum_type_def)

The location of this enum declaration.

source_module_name(enum_type_def)

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

values(enum_type_def) deprecated

Types

t()

@type t() :: %Dagger.EnumTypeDef{client: term(), query_builder: term()}

Functions

description(enum_type_def)

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

A doc string for the enum, if any.

id(enum_type_def)

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

A unique identifier for this EnumTypeDef.

members(enum_type_def)

@spec members(t()) :: {:ok, [Dagger.EnumValueTypeDef.t()]} | {:error, term()}

The members of the enum.

name(enum_type_def)

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

The name of the enum.

source_map(enum_type_def)

@spec source_map(t()) :: Dagger.SourceMap.t() | nil

The location of this enum declaration.

source_module_name(enum_type_def)

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

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

values(enum_type_def)

This function is deprecated. use members instead . 
@spec values(t()) :: {:ok, [Dagger.EnumValueTypeDef.t()]} | {:error, term()}