Dagger.Generator (dagger v1.0.0-beta.12)

Dagger.Generator

Summary

Types

t()

Functions

changes(generator)

The generated changeset from the last run

completed(generator)

Whether the generator complete

description(generator)

Return the description of the generator

empty?(generator)

Whether changeset from the last generator run is empty or not

id(generator)

A unique identifier for this Generator.

name(generator)

Return the command name of the generator. Entrypoint targets omit the module prefix.

original_module(generator)

The module that defined the generator, or null for an engine-defined generator

path(generator)

The path of the generator within its module

run(generator)

Execute the generator

Types

t()

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

Functions

changes(generator)

@spec changes(t()) :: Dagger.Changeset.t()

The generated changeset from the last run

completed(generator)

@spec completed(t()) :: {:ok, boolean()} | {:error, term()}

Whether the generator complete

description(generator)

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

Return the description of the generator

empty?(generator)

@spec empty?(t()) :: {:ok, boolean()} | {:error, term()}

Whether changeset from the last generator run is empty or not

id(generator)

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

A unique identifier for this Generator.

name(generator)

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

Return the command name of the generator. Entrypoint targets omit the module prefix.

original_module(generator)

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

The module that defined the generator, or null for an engine-defined generator

path(generator)

@spec path(t()) :: {:ok, [String.t()]} | {:error, term()}

The path of the generator within its module

run(generator)

@spec run(t()) :: t()

Execute the generator