Struct FlagSnapshot 

pub struct FlagSnapshot {

    pub short: Option<char>,
    pub long: Option<String>,
    pub value_name: Option<String>,
    pub value_kind: ValueKind,
    pub choices: Vec<String>,
    pub repeatable: bool,
    pub required: bool,
    pub negatable: bool,
    pub hidden: bool,
    pub deprecated: Option<String>,
    pub inherited: bool,
    pub group: Option<String>,
    pub description: Option<String>,
    pub default: Option<String>,
    pub env_var: Option<String>,
    pub provenance: ProvenanceSnapshot,
}

Snapshot form of Flag. Field order matches Flag’s own declaration; every Option/Vec field is omitted when empty, every bool field is omitted when false.

Fields

short: Option<char>

Short spelling, e.g. 'i' for -i.

long: Option<String>

Long spelling, e.g. "interactive" for --interactive.

value_name: Option<String>

The value placeholder, e.g. "FILE" in --output FILE.

value_kind: ValueKind

Whether this flag takes no value, a required value, or an optional one. Omitted for the common no-value case.

choices: Vec<String>

Enumerated choices, e.g. {json|yaml|table} for --format.

repeatable: bool

True if this flag may be given more than once.

required: bool

True if this flag is required.

negatable: bool

True if the tool documents this boolean’s negation inline (--[no-]foo). long holds the base name either way.

hidden: bool

True if this flag should be hidden by default.

deprecated: Option<String>

The deprecation reason, when deprecated.

inherited: bool

True when inherited from an ancestor node.

group: Option<String>

Display grouping from the source, e.g. tar’s “Main operation mode”.

description: Option<String>

The flag’s description.

default: Option<String>

The flag’s default value, if documented.

env_var: Option<String>

An environment variable that also sets this flag, if documented.

provenance: ProvenanceSnapshot

Which source(s) contributed this flag’s fields.

Trait Implementations

impl Clone for FlagSnapshot

fn clone(&self) -> FlagSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlagSnapshot

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

Formats the value using the given formatter.

impl From<&Flag> for FlagSnapshot

fn from(f: &Flag) -> Self

Converts to this type from the input type.

impl PartialEq for FlagSnapshot

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FlagSnapshot

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 FlagSnapshot