Struct dagger_sdk::Function

pub struct Function {
    pub proc: Option<Arc<Child>>,
    pub selection: Selection,
    pub graphql_client: DynGraphQLClient,
}

Fields

proc: Option<Arc<Child>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl Function

pub fn args(&self) -> Vec<FunctionArg>

Arguments accepted by this function, if any

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

Execute this function using dynamic input+output types. Typically, it’s preferable to invoke a function using a type safe graphql query rather than using this call field. However, call is useful for some advanced use cases where dynamically loading arbitrary modules and invoking functions in them is required.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn call_opts( &self, opts: FunctionCallOpts ) -> Result<Json, DaggerError>

Execute this function using dynamic input+output types. Typically, it’s preferable to invoke a function using a type safe graphql query rather than using this call field. However, call is useful for some advanced use cases where dynamically loading arbitrary modules and invoking functions in them is required.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

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

A doc string for the function, if any

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

The ID of the function

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

The name of the function

pub fn return_type(&self) -> TypeDef

The type returned by this function

pub fn with_arg(&self, name: impl Into<String>, type_def: TypeDef) -> Function

Returns the function with the provided argument

Arguments

• name - The name of the argument
• type_def - The type of the argument
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_arg_opts<'a>( &self, name: impl Into<String>, type_def: TypeDef, opts: FunctionWithArgOpts<'a> ) -> Function

Returns the function with the provided argument

Arguments

• name - The name of the argument
• type_def - The type of the argument
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_description(&self, description: impl Into<String>) -> Function

Returns the function with the doc string

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.