Enum clap::ArgSettings

[+] Show declaration

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

[−] Expand description

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

[−] Expand description

The argument must be used

Multiple

[−] Expand description

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

EmptyValues

[−] Expand description

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

Global

[−] Expand description

The argument should be propagated down through all child [SubCommands] [SubCommand]: ./struct.SubCommand.html

Hidden

[−] Expand description

The argument should not be shown in help text

TakesValue

[−] Expand description

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

UseValueDelimiter

[−] Expand description

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

NextLineHelp

[−] Expand description

Prints the help text on the line after the argument

RequireDelimiter

[−] Expand description

Requires the use of a value delimiter for all multiple values

HidePossibleValues

[−] Expand description

Hides the possible values from the help string

AllowLeadingHyphen

[−] Expand description

Allows vals that start with a '-'

RequireEquals

[−] Expand description

Require options use --option=val syntax

Last

[−] Expand description

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

HideDefaultValue

[−] Expand description

Hides the default value from the help string

CaseInsensitive

[−] Expand description

Makes Arg::possible_values case insensitive

HideEnvValues

[−] Expand description

Hides ENV values in the help message

HiddenShortHelp

[−] Expand description

The argument should not be shown in short help text

HiddenLongHelp

[−] Expand description

The argument should not be shown in long help text

Trait Implementations

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 Copy for ArgSettings

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 ==.

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

[−]

This method tests for !=.

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.