Struct FunctionArg

pub struct FunctionArg {
    pub proc: Option<Arc<DaggerSessionProc>>,
    pub selection: Selection,
    pub graphql_client: DynGraphQLClient,
}

Fields

proc: Option<Arc<DaggerSessionProc>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl FunctionArg

pub async fn default_path(&self) -> Result<String, DaggerError>

Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory

pub async fn default_value(&self) -> Result<Json, DaggerError>

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

pub async fn description(&self) -> Result<String, DaggerError>

A doc string for the argument, if any.

pub async fn id(&self) -> Result<FunctionArgId, DaggerError>

A unique identifier for this FunctionArg.

pub async fn ignore(&self) -> Result<Vec<String>, DaggerError>

Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner.

pub async fn name(&self) -> Result<String, DaggerError>

The name of the argument in lowerCamelCase format.

pub fn source_map(&self) -> SourceMap

The location of this arg declaration.

pub fn type_def(&self) -> TypeDef

The type of the argument.

Trait Implementations

impl Clone for FunctionArg

fn clone(&self) -> FunctionArg

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl IntoID<FunctionArgId> for FunctionArg

fn into_id( self, ) -> Pin<Box<dyn Future<Output = Result<FunctionArgId, DaggerError>> + Send>>