Struct OptionDefinition 

pub struct OptionDefinition {
    pub name: String,
    pub short: Option<String>,
    pub long: Option<String>,
    pub option_type: ArgumentType,
    pub required: bool,
    pub default: Option<String>,
    pub description: String,
    pub choices: Vec<String>,
    pub repeatable: bool,
    pub option_parameters: HashMap<String, Vec<ArgumentDefinition>>,
}

Definition of a named option (flag)

Options are optional (by default) and can be specified with short (-o) or long (--option) forms.

Example

name: output
short: o
long: output
option_type: path
required: false
default: "output.txt"
description: "Output file path"
choices: []

Fields

name: String

Option name (internal identifier)

short: Option<String>

Short form (single character, e.g., “o” for -o)

long: Option<String>

Long form (e.g., “output” for –output)

option_type: ArgumentType

Expected type of the option value

required: bool

Whether this option is mandatory

default: Option<String>

Default value if not specified

description: String

Human-readable description

choices: Vec<String>

Restricted set of allowed values

If non-empty, the value must be one of these choices. When repeatable is true, this list also doubles as the set of valid discriminants for each occurrence (see Self::option_parameters).

repeatable: bool

Whether this option can appear more than once on a single command line, each occurrence carrying its own discriminant (from choices) and key=value sub-parameters.

Defaults to false — fully backward-compatible with existing scalar options.

option_parameters: HashMap<String, Vec<ArgumentDefinition>>

Per-discriminant shape of the key=value sub-parameters accepted by a repeatable option.

Keys must exactly match the entries in Self::choices (enforced by the config validator, not at deserialization time). Each value reuses ArgumentDefinition — the same vocabulary already used for positional arguments: — rather than a dedicated mini-schema type.

Ignored (and should be empty) when repeatable is false.

Trait Implementations

impl Clone for OptionDefinition

fn clone(&self) -> OptionDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OptionDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OptionDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OptionDefinition

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 OptionDefinition