logo
#[non_exhaustive]
pub enum ArgSettings {
Show 22 variants 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
}
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 (Non-exhaustive)

This enum is marked as 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 since 3.1.0:

Replaced with Arg::required and Arg::is_required_set

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

MultipleValues

👎 Deprecated since 3.1.0:

Replaced with Arg::multiple_values and Arg::is_multiple_values_set`

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

MultipleOccurrences

👎 Deprecated since 3.1.0:

Replaced with Arg::multiple_occurrences and Arg::is_multiple_occurrences_set

ForbidEmptyValues

👎 Deprecated since 3.1.0:

Replaced with Arg::forbid_empty_values and Arg::is_forbid_empty_values_set

Global

👎 Deprecated since 3.1.0:

Replaced with Arg::global and Arg::is_global_set

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

Hidden

👎 Deprecated since 3.1.0:

Replaced with Arg::hide and Arg::is_hide_set

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

TakesValue

👎 Deprecated since 3.1.0:

Replaced with Arg::takes_value and Arg::is_takes_value_set

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

UseValueDelimiter

👎 Deprecated since 3.1.0:

Replaced with Arg::use_value_delimiter and Arg::is_use_value_delimiter_set

NextLineHelp

👎 Deprecated since 3.1.0:

Replaced with Arg::next_line_help and Arg::is_next_line_help_set

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

RequireDelimiter

👎 Deprecated since 3.1.0:

Replaced with Arg::require_value_delimiter and Arg::is_require_value_delimiter_set

HidePossibleValues

👎 Deprecated since 3.1.0:

Replaced with Arg::hide_possible_values and Arg::is_hide_possible_values_set

AllowHyphenValues

👎 Deprecated since 3.1.0:

Replaced with Arg::allow_hyphen_values and Arg::is_allow_hyphen_values_set

RequireEquals

👎 Deprecated since 3.1.0:

Replaced with Arg::require_equals and Arg::is_require_equals_set

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

Last

👎 Deprecated since 3.1.0:

Replaced with Arg::last and Arg::is_last_set

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

HideDefaultValue

👎 Deprecated since 3.1.0:

Replaced with Arg::hide_default_value and Arg::is_hide_default_value_set

IgnoreCase

👎 Deprecated since 3.1.0:

Replaced with Arg::ignore_case and Arg::is_ignore_case_set

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

HideEnv

👎 Deprecated since 3.1.0:

Replaced with Arg::hide_env and Arg::is_hide_env_set

Available on crate feature env only.

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

HideEnvValues

👎 Deprecated since 3.1.0:

Replaced with Arg::hide_env_values and Arg::is_hide_env_values_set

Available on crate feature env only.

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

HiddenShortHelp

👎 Deprecated since 3.1.0:

Replaced with Arg::hide_short_help and Arg::is_hide_short_help_set

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

HiddenLongHelp

👎 Deprecated since 3.1.0:

Replaced with Arg::hide_long_help and Arg::is_hide_long_help_set

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

AllowInvalidUtf8

👎 Deprecated since 3.1.0:

Replaced with Arg::allow_invalid_utf8 and Arg::is_allow_invalid_utf8_set

Exclusive

👎 Deprecated since 3.1.0:

Replaced with Arg::exclusive and Arg::is_exclusive_set

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

Trait Implementations

The resulting type after applying the | operator.

Performs the | operation. Read more

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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

The associated error which can be returned from parsing.

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

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.