[−][src]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 Clone for ArgSettings[src][+]

impl Copy for ArgSettings[src]

impl Debug for ArgSettings[src][+]

impl FromStr for ArgSettings[src][+]

type Err = String

The associated error which can be returned from parsing.

impl PartialEq<ArgSettings> for ArgSettings[src][+]

impl StructuralPartialEq for ArgSettings[src]

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

impl<T> Any for T where
    T: 'static + ?Sized, [src][+]

impl<T> Borrow<T> for T where
    T: ?Sized, [src][+]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src][+]

impl<T> From<T> for T[src][+]

impl<T, U> Into<U> for T where
    U: From<T>, [src][+]

impl<T> ToOwned for T where
    T: Clone, [src][+]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src][+]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src][+]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.