Enum clap::ArgSettings

pub enum ArgSettings {
    Required,
    Multiple,
    EmptyValues,
    Global,
    Hidden,
    TakesValue,
    UseValueDelimiter,
    NextLineHelp,
    RequireDelimiter,
    // 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]

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 delimter

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

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

fn eq(&self, __arg_0: &ArgSettings) -> bool[−]

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

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

This method tests for !=.

impl Debug for ArgSettings

fn fmt(&self, __arg_0: &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.