Struct Parameter 

pub struct Parameter {
    pub keyword: &'static str,
    pub kind: u16,
    pub required: bool,
    pub description: &'static str,
    pub default: Option<&'static Value>,
    pub enum_variants: Option<&'static [EnumVariant]>,
}

Fields

keyword: &'static str

The keyword of the parameter.

Arguments can be passed in both using the keyword, or as a positional argument.

kind: u16

The type kind(s) this parameter expects to receive.

If an invalid kind is provided, the compiler will return a compile-time error.

required: bool

Whether or not this is a required parameter.

If it isn’t, the function can be called without errors, even if the argument matching this parameter is missing.

description: &'static str

A description of what this parameter does.

default: Option<&'static Value>

The default value for this parameter, if any.

Notes on creating a Option<&'static Value>:

• If the inner Value is copiable, such as Value::Integer, you likely won’t have issues.
• If the value can contain owned data, such as Value::Bytes, use LazyLock to create static Value instances. If you are already in a LazyLock block, you’ll have to create another LazyLock in order to make both static.

enum_variants: Option<&'static [EnumVariant]>

Enum variants for this parameter, if the parameter accepts a limited set of values.

Implementations

impl Parameter

pub const fn required( keyword: &'static str, kind: u16, description: &'static str, ) -> Self

Create a required parameter with default values for default and enum_variants.

pub const fn optional( keyword: &'static str, kind: u16, description: &'static str, ) -> Self

Create an optional parameter with default values for default and enum_variants.

pub const fn default(self, value: &'static Value) -> Self

Set the default value for this parameter.

pub const fn enum_variants(self, variants: &'static [EnumVariant]) -> Self

Set the enum variants for this parameter.

pub fn kind(&self) -> Kind

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl PartialEq for Parameter

fn eq(&self, other: &Parameter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Parameter

impl Eq for Parameter

impl StructuralPartialEq for Parameter