Enum clap::ArgSettings

pub enum ArgSettings {
    Required,
    Multiple,
    EmptyValues,
    Global,
    Hidden,
    TakesValue,
    UseValueDelimiter,
    NextLineHelp,
    RequireDelimiter,
    HidePossibleValues,
    AllowLeadingHyphen,
    RequireEquals,
    Last,
    HideDefaultValue,
    CaseInsensitive,
    HideEnvValues,
    HiddenShortHelp,
    HiddenLongHelp,
    // some variants omitted
}

Various settings that apply to arguments and may be set, unset, and checked via getter/setter methods Arg::set, Arg::unset, and Arg::is_set

Variants

Required

The argument must be used

Multiple

The argument may be used multiple times such as --flag --flag

EmptyValues

The argument allows empty values such as --option ""

Global

The argument should be propagated down through all child SubCommands

Hidden

The argument should not be shown in help text

TakesValue

The argument accepts a value, such as --option <value>

UseValueDelimiter

Determines if the argument allows values to be grouped via a delimiter

NextLineHelp

Prints the help text on the line after the argument

RequireDelimiter

Requires the use of a value delimiter for all multiple values

HidePossibleValues

Hides the possible values from the help string

AllowLeadingHyphen

Allows vals that start with a '-'

RequireEquals

Require options use --option=val syntax

Last

Specifies that the arg is the last positional argument and may be accessed early via -- syntax

HideDefaultValue

Hides the default value from the help string

CaseInsensitive

Makes Arg::possible_values case insensitive

HideEnvValues

Hides ENV values in the help message

HiddenShortHelp

The argument should not be shown in short help text

HiddenLongHelp

The argument should not be shown in long help text

Trait Implementations

impl PartialEq<ArgSettings> for ArgSettings

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for ArgSettings

impl Clone for ArgSettings

fn clone(&self) -> ArgSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgSettings

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

Formats the value using the given formatter.

impl FromStr for ArgSettings

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.