Enum clap::builder::AppSettings

source · [−]

#[non_exhaustive]
pub enum AppSettings {
Show 34 variants    IgnoreErrors,
    WaitOnError,
    AllowHyphenValues,
    AllowNegativeNumbers,
    AllArgsOverrideSelf,
    AllowMissingPositional,
    TrailingVarArg,
    DontDelimitTrailingValues,
    InferLongArgs,
    InferSubcommands,
    SubcommandRequired,
    SubcommandRequiredElseHelp,
    AllowExternalSubcommands,
    Multicall,
    AllowInvalidUtf8ForExternalSubcommands,
    UseLongFormatForHelpSubcommand,
    SubcommandsNegateReqs,
    ArgsNegateSubcommands,
    SubcommandPrecedenceOverArg,
    ArgRequiredElseHelp,
    DeriveDisplayOrder,
    DontCollapseArgsInUsage,
    NextLineHelp,
    DisableColoredHelp,
    DisableHelpFlag,
    DisableHelpSubcommand,
    DisableVersionFlag,
    PropagateVersion,
    Hidden,
    HidePossibleValues,
    HelpExpected,
    NoBinaryName,
    NoAutoHelp,
    NoAutoVersion,
    // some variants omitted
}

Expand description

Application level settings, which affect how Command operates

NOTE: When these settings are used, they apply only to current command, and are not propagated down or up through child or parent subcommands

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.

`IgnoreErrors`

Deprecated, replaced with Command::ignore_errors

`WaitOnError`

Deprecated, replace

let cmd = clap::Command::new("cmd")
    .global_setting(clap::AppSettings::WaitOnError)
    .arg(clap::arg!(--flag));
let m = cmd.get_matches();

with

let cmd = clap::Command::new("cmd")
    .arg(clap::arg!(--flag));
let m = match cmd.try_get_matches() {
    Ok(m) => m,
    Err(err) => {
        if err.use_stderr() {
            let _ = err.print();

            eprintln!("\nPress [ENTER] / [RETURN] to continue...");
            use std::io::BufRead;
            let mut s = String::new();
            let i = std::io::stdin();
            i.lock().read_line(&mut s).unwrap();

            std::process::exit(2);
        } else {
            let _ = err.print();
            std::process::exit(0);
        }
    }
};

`UseLongFormatForHelpSubcommand`

Deprecated, this is now the default

`SubcommandsNegateReqs`

Deprecated, replaced with Command::subcommand_negates_reqs and Command::is_subcommand_negates_reqs_set

`ArgsNegateSubcommands`

Deprecated, replaced with Command::args_conflicts_with_subcommands and Command::is_args_conflicts_with_subcommands_set

`SubcommandPrecedenceOverArg`

Deprecated, replaced with Command::subcommand_precedence_over_arg and Command::is_subcommand_precedence_over_arg_set

`ArgRequiredElseHelp`

Deprecated, replaced with Command::arg_required_else_help and Command::is_arg_required_else_help_set

`DeriveDisplayOrder`

Displays the arguments and subcommands in the help message in the order that they were declared in, and not alphabetically which is the default.

To override the declaration order, see Arg::display_order and Command::display_order.

Examples

Command::new("myprog")
    .global_setting(AppSettings::DeriveDisplayOrder)
    .get_matches();

`DontCollapseArgsInUsage`

Deprecated, replaced with Command::dont_collapse_args_in_usage and Command::is_dont_collapse_args_in_usage_set

`NextLineHelp`

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

`DisableColoredHelp`

Deprecated, replaced with Command::disable_colored_help and Command::is_disable_colored_help_set

`DisableHelpFlag`

Deprecated, replaced with Command::disable_help_flag and Command::is_disable_help_flag_set

`DisableHelpSubcommand`

Deprecated, replaced with Command::disable_help_subcommand and Command::is_disable_help_subcommand_set

`DisableVersionFlag`

Deprecated, replaced with Command::disable_version_flag and Command::is_disable_version_flag_set

`PropagateVersion`

Deprecated, replaced with Command::propagate_version and Command::is_propagate_version_set

`Hidden`

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

`HidePossibleValues`

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

`HelpExpected`

Deprecated, replaced with Command::help_expected

`NoBinaryName`

Deprecated, replaced with Command::no_binary_name

`NoAutoHelp`

Deprecated, replaced with Arg::action

`NoAutoVersion`

Deprecated, replaced with Arg::action

Trait Implementations

source

impl BitOr<AppSettings> for AppSettings

type Output = AppFlags

The resulting type after applying the | operator.

source

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

Performs the | operation. Read more

source

impl Clone for AppSettings

source

fn clone(&self) -> AppSettings

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for AppSettings

source

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

Formats the value using the given formatter. Read more

source

impl PartialEq<AppSettings> for AppSettings

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl Copy for AppSettings

source

impl StructuralPartialEq for AppSettings

Auto Trait Implementations

impl RefUnwindSafe for AppSettings

impl Send for AppSettings

impl Sync for AppSettings

impl Unpin for AppSettings

impl UnwindSafe for AppSettings

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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,

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)

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Enum clap::builder::AppSettings

Variants (Non-exhaustive)

IgnoreErrors

WaitOnError

AllowHyphenValues

AllowNegativeNumbers

AllArgsOverrideSelf

AllowMissingPositional

TrailingVarArg

DontDelimitTrailingValues

InferLongArgs

InferSubcommands

SubcommandRequired

SubcommandRequiredElseHelp

AllowExternalSubcommands

Multicall

AllowInvalidUtf8ForExternalSubcommands

UseLongFormatForHelpSubcommand

SubcommandsNegateReqs

ArgsNegateSubcommands

SubcommandPrecedenceOverArg

ArgRequiredElseHelp

DeriveDisplayOrder

Examples

DontCollapseArgsInUsage

NextLineHelp

DisableColoredHelp

DisableHelpFlag

DisableHelpSubcommand

DisableVersionFlag

PropagateVersion

Hidden

HidePossibleValues

HelpExpected

NoBinaryName

NoAutoHelp

NoAutoVersion

Trait Implementations

impl BitOr<AppSettings> for AppSettings

type Output = AppFlags

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

impl Clone for AppSettings

fn clone(&self) -> AppSettings

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

impl Debug for AppSettings

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

impl PartialEq<AppSettings> for AppSettings

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

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

impl Copy for AppSettings

impl StructuralPartialEq for AppSettings

Auto Trait Implementations

impl RefUnwindSafe for AppSettings

impl Send for AppSettings

impl Sync for AppSettings

impl Unpin for AppSettings

impl UnwindSafe for AppSettings

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

`IgnoreErrors`

`WaitOnError`

`AllowHyphenValues`

`AllowNegativeNumbers`

`AllArgsOverrideSelf`

`AllowMissingPositional`

`TrailingVarArg`

`DontDelimitTrailingValues`

`InferLongArgs`

`InferSubcommands`

`SubcommandRequired`

`SubcommandRequiredElseHelp`

`AllowExternalSubcommands`

`Multicall`

`AllowInvalidUtf8ForExternalSubcommands`

`UseLongFormatForHelpSubcommand`

`SubcommandsNegateReqs`

`ArgsNegateSubcommands`

`SubcommandPrecedenceOverArg`

`ArgRequiredElseHelp`

`DeriveDisplayOrder`

`DontCollapseArgsInUsage`

`NextLineHelp`

`DisableColoredHelp`

`DisableHelpFlag`

`DisableHelpSubcommand`

`DisableVersionFlag`

`PropagateVersion`

`Hidden`

`HidePossibleValues`

`HelpExpected`

`NoBinaryName`

`NoAutoHelp`

`NoAutoVersion`

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

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

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

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

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

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

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