Struct ParamInfo

pub struct ParamInfo {
    pub name: &'static str,
    pub docs: &'static str,
    pub input: CastInfo,
    pub default: Option<fn() -> Value>,
    pub positional: bool,
    pub named: bool,
    pub variadic: bool,
    pub required: bool,
    pub settable: bool,
}

Describes a function parameter.

Fields

name: &'static str

The parameter’s name.

docs: &'static str

Documentation for the parameter.

input: CastInfo

Describe what values this parameter accepts.

default: Option<fn() -> Value>

Creates an instance of the parameter’s default value.

positional: bool

Is the parameter positional?

named: bool

Is the parameter named?

Can be true even if positional is true if the parameter can be given in both variants.

variadic: bool

Can the parameter be given any number of times?

required: bool

Is the parameter required?

settable: bool

Is the parameter settable with a set rule?

Trait Implementations

impl Clone for ParamInfo

fn clone(&self) -> ParamInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParamInfo

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

Formats the value using the given formatter.