Struct FlagDef 

pub struct FlagDef {

    pub id: String,
    pub short: Option<char>,
    pub long: Option<String>,
    pub aliases: Vec<String>,
    pub help: Option<String>,
    pub help_heading: Option<String>,
    pub takes_value: bool,
    pub value_name: Option<String>,
    pub required: bool,
    pub multi: bool,
    pub hidden: bool,
    pub value_kind: Option<ValueKind>,
    pub choices: Vec<ValueChoice>,
    pub defaults: Vec<String>,
}

Flag or option definition for a command.

Fields

id: String

Stable identifier for the flag or option.

short: Option<char>

Single-character short form without the leading -.

long: Option<String>

Long form without the leading --.

aliases: Vec<String>

Alternate visible spellings accepted for the flag.

help: Option<String>

Help text shown for the flag.

help_heading: Option<String>

Optional help section heading for the flag.

takes_value: bool

Whether the flag consumes a value.

value_name: Option<String>

Placeholder shown for the flag value in help text.

required: bool

Whether the flag must be supplied.

multi: bool

Whether the flag accepts multiple values or occurrences.

hidden: bool

Whether the flag should be hidden from generated discovery output.

value_kind: Option<ValueKind>

Semantic hint for the flag value.

choices: Vec<ValueChoice>

Enumerated values suggested for the flag.

defaults: Vec<String>

Default values applied when the flag is omitted.

Implementations

impl FlagDef

pub fn new(id: impl Into<String>) -> Self

Creates a flag definition with the provided identifier.

pub fn short(self, short: char) -> Self

Sets the short option name.

pub fn long(self, long: impl Into<String>) -> Self

Sets the long option name without the leading --.

pub fn alias(self, alias: impl Into<String>) -> Self

Appends an alias name for this flag.

pub fn aliases( self, aliases: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Appends multiple alias names for this flag.

pub fn help(self, help: impl Into<String>) -> Self

Sets the help text for the flag.

pub fn takes_value(self, value_name: impl Into<String>) -> Self

Marks the flag as taking a value and sets its displayed value name.

pub fn required(self) -> Self

Marks the flag as required.

pub fn multi(self) -> Self

Marks the flag as accepting multiple values or occurrences.

pub fn hidden(self) -> Self

Marks the flag as hidden from generated help and discovery output.

pub fn value_kind(self, value_kind: ValueKind) -> Self

Sets the semantic value kind for the flag’s value.

pub fn choices(self, choices: impl IntoIterator<Item = ValueChoice>) -> Self

Appends supported value choices for the flag.

pub fn defaults( self, defaults: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Appends default values for the flag.

pub fn takes_no_value(self) -> Self

Marks the flag as not taking a value and clears any stored value name.

Trait Implementations

impl Clone for FlagDef

fn clone(&self) -> FlagDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlagDef

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

Formats the value using the given formatter.

impl Default for FlagDef

fn default() -> FlagDef

Returns the “default value” for a type.

impl From<&DescribeFlagV1> for FlagDef

fn from(flag: &DescribeFlagV1) -> Self

Converts to this type from the input type.

impl From<&FlagDef> for DescribeFlagV1

fn from(flag: &FlagDef) -> Self

Converts to this type from the input type.

impl PartialEq for FlagDef

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

impl StructuralPartialEq for FlagDef