Struct Function 

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

Fields

proc: Option<Arc<DaggerSessionProc>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl Function

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

Arguments accepted by the function, if any.

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

The reason this function is deprecated, if any.

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

A doc string for the function, if any.

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

A unique identifier for this Function.

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

The name of the function.

pub fn return_type(&self) -> TypeDef

The type returned by the function.

pub fn source_map(&self) -> SourceMap

The location of this function declaration.

pub fn with_arg( &self, name: impl Into<String>, type_def: impl IntoID<TypeDefId>, ) -> 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: impl IntoID<TypeDefId>, 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_cache_policy(&self, policy: FunctionCachePolicy) -> Function

Returns the function updated to use the provided cache policy.

Arguments

• policy - The cache policy to use.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_cache_policy_opts<'a>( &self, policy: FunctionCachePolicy, opts: FunctionWithCachePolicyOpts<'a>, ) -> Function

Returns the function updated to use the provided cache policy.

Arguments

• policy - The cache policy to use.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_check(&self) -> Function

Returns the function with a flag indicating it’s a check.

pub fn with_deprecated(&self) -> Function

Returns the function with the provided deprecation reason.

Arguments

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

pub fn with_deprecated_opts<'a>( &self, opts: FunctionWithDeprecatedOpts<'a>, ) -> Function

Returns the function with the provided deprecation reason.

Arguments

• 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 given doc string.

Arguments

• description - The doc string to set.

pub fn with_generator(&self) -> Function

Returns the function with a flag indicating it’s a generator.

pub fn with_source_map(&self, source_map: impl IntoID<SourceMapId>) -> Function

Returns the function with the given source map.

Arguments

• source_map - The source map for the function definition.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl IntoID<FunctionId> for Function

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