Skip to main content

ArgSettings

Enum ArgSettings 

Source
pub enum ArgSettings {
Show 18 variants Required, Multiple, EmptyValues, Global, Hidden, TakesValue, UseValueDelimiter, NextLineHelp, RequireDelimiter, HidePossibleValues, AllowLeadingHyphen, RequireEquals, Last, HideDefaultValue, CaseInsensitive, 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::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§

Source§

impl Clone for ArgSettings

Source§

fn clone(&self) -> ArgSettings

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for ArgSettings

Source§

impl Debug for ArgSettings

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl FromStr for ArgSettings

Source§

type Err = String

The associated error which can be returned from parsing.
Source§

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

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

impl PartialEq for ArgSettings

Source§

fn eq(&self, other: &ArgSettings) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ArgSettings

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.