Enum clap::ArgSettings

#[non_exhaustive]
pub enum ArgSettings {
    Required,
    MultipleValues,
    MultipleOccurrences,
    ForbidEmptyValues,
    Global,
    Hidden,
    TakesValue,
    UseValueDelimiter,
    NextLineHelp,
    RequireDelimiter,
    HidePossibleValues,
    AllowHyphenValues,
    RequireEquals,
    Last,
    HideDefaultValue,
    IgnoreCase,
    HideEnv,
    HideEnvValues,
    HiddenShortHelp,
    HiddenLongHelp,
    AllowInvalidUtf8,
    Exclusive,
    // some variants omitted
}

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 (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Required

Deprecated, replaced with Arg::required and Arg::is_required_set

MultipleValues

Deprecated, replaced with Arg::multiple_values and Arg::is_multiple_values_set

MultipleOccurrences

Deprecated, replaced with Arg::action (Issue #3772)

ForbidEmptyValues

Deprecated, replaced with [Arg::value_parser(NonEmptyStringValueParser::new())]

Global

Deprecated, replaced with Arg::global and Arg::is_global_set

Hidden

Deprecated, replaced with Arg::hide and Arg::is_hide_set

TakesValue

Deprecated, replaced with Arg::takes_value and Arg::is_takes_value_set

UseValueDelimiter

Deprecated, replaced with Arg::use_value_delimiter and Arg::is_use_value_delimiter_set

NextLineHelp

Deprecated, replaced with Arg::next_line_help and Arg::is_next_line_help_set

RequireDelimiter

Deprecated, replaced with Arg::require_value_delimiter and Arg::is_require_value_delimiter_set

HidePossibleValues

Deprecated, replaced with Arg::hide_possible_values and Arg::is_hide_possible_values_set

AllowHyphenValues

Deprecated, replaced with Arg::allow_hyphen_values and Arg::is_allow_hyphen_values_set

RequireEquals

Deprecated, replaced with Arg::require_equals and Arg::is_require_equals_set

Last

Deprecated, replaced with Arg::last and Arg::is_last_set

HideDefaultValue

Deprecated, replaced with Arg::hide_default_value and Arg::is_hide_default_value_set

IgnoreCase

Deprecated, replaced with Arg::ignore_case and Arg::is_ignore_case_set

HideEnv

Available on crate feature env only.

Deprecated, replaced with Arg::hide_env and Arg::is_hide_env_set

HideEnvValues

Available on crate feature env only.

Deprecated, replaced with Arg::hide_env_values and Arg::is_hide_env_values_set

HiddenShortHelp

Deprecated, replaced with Arg::hide_short_help and Arg::is_hide_short_help_set

HiddenLongHelp

Deprecated, replaced with Arg::hide_long_help and Arg::is_hide_long_help_set

AllowInvalidUtf8

Deprecated, replaced with Arg::allow_invalid_utf8 and Arg::is_allow_invalid_utf8_set

Exclusive

Deprecated, replaced with Arg::exclusive and Arg::is_exclusive_set

Trait Implementations

impl BitOr<ArgSettings> for ArgSettings

type Output = ArgFlags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

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

Available on crate feature yaml only.

Deprecated in Issue #3087, maybe clap::Parser would fit your use case?

type Err = String

The associated error which can be returned from parsing.

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

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ArgSettings

impl StructuralPartialEq for ArgSettings