Struct hcl::eval::FuncDefBuilder

pub struct FuncDefBuilder { /* private fields */ }

A builder for FuncDef values.

The builder is created by the .builder() method of FuncDef.

See the type-level documentation of FuncDef and builder method docs for usage examples.

Implementations

impl FuncDefBuilder

pub fn param(self, param: ParamType) -> FuncDefBuilder

Adds a function parameter.

Calls to .param() and .params() can be mixed and will always add more parameters to the function definition instead of overwriting existing ones.

Examples

let func_def = FuncDef::builder()
    .param(ParamType::String)
    .build(strlen);

pub fn params<I>(self, params: I) -> FuncDefBuilder

where I: IntoIterator<Item = ParamType>,

Adds function parameters from an iterator.

Calls to .params() and .param() can be mixed and will always add more parameters to the function definition instead of overwriting existing ones.

Examples

let func_def = FuncDef::builder()
    .params([
        ParamType::Number,
        ParamType::Number,
        ParamType::Number,
    ])
    .build(add3);

pub fn variadic_param(self, param: ParamType) -> FuncDefBuilder

Adds a variadic parameter to the function definition.

Only one variadic parameter can be added. Subsequent invocation of this method will overwrite a previously set variadic parameter.

Examples

let func_def = FuncDef::builder()
    .param(ParamType::String)
    .variadic_param(ParamType::Any)
    .build(printf);

pub fn build(self, func: Func) -> FuncDef

Takes ownership of the builder and builds the FuncDef for the provided function and the contents of the builder.

Trait Implementations

impl Debug for FuncDefBuilder

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

Formats the value using the given formatter.