Enum clap::ArgSettings [−][src]
pub enum ArgSettings {}Show 19 variants
Required, MultipleValues, MultipleOccurrences, ForbidEmptyValues, Hidden, TakesValue, UseValueDelimiter, NextLineHelp, RequireDelimiter, HidePossibleValues, AllowHyphenValues, RequireEquals, Last, HideDefaultValue, IgnoreCase, HideEnv, 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::setting
, Arg::unset_setting
, and Arg::is_set
. This is what the
Arg
methods which accept a bool
use internally.
Variants
Specifies that an arg must be used
Allows an arg to accept multiple values
Allows an arg to appear multiple times
Forbids an arg from accepting empty values such as ""
Hides an arg from the help message
Allows an argument to take a value (such as --option value
)
Enables a delimiter to break up arguments --option val1,val2,val3
becomes three values
(val1
, val2
, and val3
) instead of the default one (val1,val2,val3
)
Tells an arg to display it’s help on the line below the arg itself in the help message
Says that arg must use a delimiter to separate values
Hides the possible values from the help message
Allows values that start with a hyphen
Requires that an equals be used to provide a value to an option such as --option=value
Says that a positional arg will be the last positional, and requires --
to be accessed.
It can also be accessed early (i.e. before other positionals) by providing --
Hides the default value from the help message
Possible values become case insensitive
Hides environment variable arguments from the help message
Hides any values currently assigned to ENV variables in the help message (good for sensitive information)
The argument should not be shown in short help text
The argument should not be shown in long help text
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for ArgSettings
impl Send for ArgSettings
impl Sync for ArgSettings
impl Unpin for ArgSettings
impl UnwindSafe for ArgSettings
Blanket Implementations
Mutably borrows from an owned value. Read more