Struct OptionSpec 

pub struct OptionSpec {
    pub short_flags: Vec<String>,
    pub long_flags: Vec<String>,
    pub description: Option<String>,
    pub option_type: OptionType,
    pub required: bool,
    pub default_value: Option<String>,
    pub takes_argument: bool,
    pub argument_name: Option<String>,
    pub choices: Vec<String>,
}

Structured description of a single CLI option/flag.

Fields

short_flags: Vec<String>

Short flags, e.g. [“-h”, “-v”]

long_flags: Vec<String>

Long flags, e.g. [“–help”, “–verbose”]

description: Option<String>

A brief description, if we could extract one.

option_type: OptionType

Type of the option (boolean, string, number, choice, path).

required: bool

Whether the option is required.

default_value: Option<String>

Default value, if any.

takes_argument: bool

Whether the option takes an argument (true for --file <FILE>, false for --verbose).

argument_name: Option<String>

Name of the argument, if takes_argument is true (e.g. "FILE", "PATH").

choices: Vec<String>

For choice/enum options, the available choices.

Trait Implementations

impl Clone for OptionSpec

fn clone(&self) -> OptionSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OptionSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OptionSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.