View Source Dagger.FunctionArg (dagger v0.10.0)

An argument accepted by a function.

This is a specification for an argument at function definition time, not an argument passed at function call time.

Link to this section Summary

Functions

A default value to use for this argument when not explicitly set by the caller, if any.

A doc string for the argument, if any.

A unique identifier for this FunctionArg.

The name of the argument in lowerCamelCase format.

The type of the argument.

Link to this section Types

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

Link to this section Functions

Link to this function

default_value(function_arg)

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

A default value to use for this argument when not explicitly set by the caller, if any.

Link to this function

description(function_arg)

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

A doc string for the argument, if any.

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

A unique identifier for this FunctionArg.

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

The name of the argument in lowerCamelCase format.

@spec type_def(t()) :: Dagger.TypeDef.t()

The type of the argument.