[−][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]

`fn clone(&self) -> ArgSettings`[src]

`default fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from source. Read more

`impl Copy for ArgSettings`[src]

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

`fn eq(&self, other: &ArgSettings) -> bool`[src]

`#[must_use] default fn ne(&self, other: &Rhs) -> bool`
1.0.0
[src]

This method tests for !=.

`impl Debug for ArgSettings`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl FromStr for ArgSettings`[src]

`type Err = String`

The associated error which can be returned from parsing.

`fn from_str(s: &str) -> Result<Self, Self::Err>`[src]

Auto Trait Implementations

`impl Send for ArgSettings`

`impl Sync for ArgSettings`

Blanket Implementations

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

`fn into(self) -> U`[src]

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

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

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

`fn from(t: T) -> T`[src]

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

`type Error = Infallible`

The type returned in the event of a conversion error.

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

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

`fn borrow(&self) -> &T`[src]

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

`fn borrow_mut(&mut self) -> &mut T`[src]

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

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

The type returned in the event of a conversion error.

[−][src]Enum clap::ArgSettings

Variants

Trait Implementations

`impl Clone for ArgSettings`[src]

`fn clone(&self) -> ArgSettings`[src]

`default fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

`impl Copy for ArgSettings`[src]

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

`fn eq(&self, other: &ArgSettings) -> bool`[src]

`#[must_use] default fn ne(&self, other: &Rhs) -> bool`
1.0.0
[src]

`impl Debug for ArgSettings`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl FromStr for ArgSettings`[src]

`type Err = String`

`fn from_str(s: &str) -> Result<Self, Self::Err>`[src]

Auto Trait Implementations

`impl Send for ArgSettings`

`impl Sync for ArgSettings`

Blanket Implementations

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

`fn into(self) -> U`[src]

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

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

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

`fn from(t: T) -> T`[src]

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

`type Error = Infallible`

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

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

`fn borrow(&self) -> &T`[src]

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

`fn borrow_mut(&mut self) -> &mut T`[src]

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

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

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

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

`fn type_id(&self) -> TypeId`[src]

[−][src]Enum clap::ArgSettings

Variants

Trait Implementations

impl Clone for ArgSettings[src]

fn clone(&self) -> ArgSettings[src]

default fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Copy for ArgSettings[src]

impl PartialEq<ArgSettings> for ArgSettings[src]

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

#[must_use] default fn ne(&self, other: &Rhs) -> bool1.0.0[src]

impl Debug for ArgSettings[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl FromStr for ArgSettings[src]

type Err = String

fn from_str(s: &str) -> Result<Self, Self::Err>[src]

Auto Trait Implementations

impl Send for ArgSettings

impl Sync for ArgSettings

Blanket Implementations

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

fn into(self) -> U[src]

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

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T> From for T[src]

fn from(t: T) -> T[src]

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

type Error = Infallible

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

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

fn borrow(&self) -> &T[src]

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

fn borrow_mut(&mut self) -> &mut T[src]

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

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

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

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

fn type_id(&self) -> TypeId[src]

`impl Clone for ArgSettings`[src]

`fn clone(&self) -> ArgSettings`[src]

`default fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

`impl Copy for ArgSettings`[src]

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

`fn eq(&self, other: &ArgSettings) -> bool`[src]

`#[must_use] default fn ne(&self, other: &Rhs) -> bool`
1.0.0
[src]

`impl Debug for ArgSettings`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl FromStr for ArgSettings`[src]

`type Err = String`

`fn from_str(s: &str) -> Result<Self, Self::Err>`[src]

`impl Send for ArgSettings`

`impl Sync for ArgSettings`

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

`fn into(self) -> U`[src]

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

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

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

`fn from(t: T) -> T`[src]

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

`type Error = Infallible`

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

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

`fn borrow(&self) -> &T`[src]

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

`fn borrow_mut(&mut self) -> &mut T`[src]

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

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

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

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

`fn type_id(&self) -> TypeId`[src]