Struct ConfigFunction 

pub struct ConfigFunction {
    pub returns: Option<ValidationType>,
    pub parameters: Option<IndexMap<String, SchemaAttribute>>,
    pub transform: Option<FunctionTransformHook>,
    pub validate: Option<FunctionValidateHook>,
}

A function a document may call in an attribute value.

Mirrors upstream’s ConfigFunction. Both hooks are synchronous; see DIVERGENCES.md entry 3.

Fields

returns: Option<ValidationType>

What the call returns, used to type-check the attribute it feeds.

Checked only when ValidationOptions::validate_functions is on.

parameters: Option<IndexMap<String, SchemaAttribute>>

The declared parameters, keyed as the call sites key them.

None means the function declares no parameters and none are checked; Some of an empty map means every parameter passed is invalid. A positional argument is keyed by its decimal index – see Function::positional_key – which is why this is a string-keyed map rather than a list.

transform: Option<FunctionTransformHook>

Turns a call into a value at transform time.

validate: Option<FunctionValidateHook>

Reports problems with a call beyond what the parameter declarations catch.

Trait Implementations

impl Clone for ConfigFunction

fn clone(&self) -> ConfigFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFunction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConfigFunction

fn default() -> ConfigFunction

Returns the “default value” for a type.