Struct ParamSpec 

pub struct ParamSpec {
    pub name: String,
    pub kind: ParamType,
    pub default: Value,
    pub help: String,
    pub required: bool,
    pub group: Option<String>,
}

One described parameter.

Fields

name: String

Stable identifier, snake_case.

kind: ParamType

Type and constraints.

default: Value

Default value, already valid for the type.

help: String

Help text.

required: bool

Whether the caller must provide it.

group: Option<String>

Optional grouping label for a user interface.

Implementations

impl ParamSpec

pub fn validate(&self, value: &Value) -> Result<(), Error>

Validates a value against this specification.

Errors

Returns Error::InvalidInput with a message naming the parameter.

Trait Implementations

impl Clone for ParamSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParamSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ParamSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ParamSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ParamSpec