Struct OptionDef 

pub struct OptionDef {
    pub long: String,
    pub short: Option<char>,
    pub placeholder: String,
    pub description: String,
    pub required: bool,
    pub default: Option<String>,
    pub env_var: Option<String>,
    pub multi: bool,
    pub hidden: bool,
}

Definition of a key-value option (e.g. --output FILE / -o FILE).

Fields

long: String

Long name used as --name.

short: Option<char>

Optional single-character short form used as -c.

placeholder: String

Placeholder shown in help text (e.g. FILE, NUM).

description: String

Human-readable description shown in help text.

required: bool

When true, parsing fails if this option is not provided.

default: Option<String>

Default value used when the option is absent from CLI and env.

env_var: Option<String>

Environment variable name to check as a fallback.

multi: bool

When true, repeated occurrences are collected into a Vec.

hidden: bool

When true, this option is omitted from help text but still parsed.

Trait Implementations

impl Clone for OptionDef

fn clone(&self) -> OptionDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionDef

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

Formats the value using the given formatter.

impl From<Opt> for OptionDef

fn from(o: Opt) -> OptionDef

Converts to this type from the input type.

impl PartialEq for OptionDef

fn eq(&self, other: &OptionDef) -> 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 Eq for OptionDef

impl StructuralPartialEq for OptionDef