Enum hcl::eval::ParamType

pub enum ParamType {
    Any,
    Bool,
    Number,
    String,
    Array(Box<ParamType>),
    Object(Box<ParamType>),
    OneOf(Vec<ParamType>),
    Nullable(Box<ParamType>),
}

A type hint for a function parameter.

The parameter type is used to validate the arguments of a function call expression before evaluating the function.

See the documentation of FuncDef for usage examples.

Variants

Any

Any type is allowed.

Bool

The parameter must be a boolean value.

Number

The parameter must be a number.

String

The parameter must be a string value.

Array(Box<ParamType>)

The parameter must be an array which must contain only elements of the given element type.

Object(Box<ParamType>)

The parameter must be an object which must contain only entries with values of the given element type. The object key type is always a string.

OneOf(Vec<ParamType>)

The parameter can be one of the provided types. If the Vec is empty, any type is allowed.

Nullable(Box<ParamType>)

The parameter must be either null or of the provided type.

Implementations

impl ParamType

pub fn array_of(element: ParamType) -> Self

Creates a new Array parameter type with the given element type.

pub fn object_of(element: ParamType) -> Self

Creates a new Object parameter type with the given element type.

The object key type is always a string and thus not specified here.

pub fn one_of<I>(alternatives: I) -> Self

where I: IntoIterator<Item = ParamType>,

Creates a new OneOf parameter type from the provided alternatives.

pub fn nullable(non_null: ParamType) -> Self

Creates a new Nullable parameter type from a non-null parameter type.

Trait Implementations

impl Clone for ParamType

fn clone(&self) -> ParamType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParamType

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

Formats the value using the given formatter.

impl Display for ParamType

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

Formats the value using the given formatter.