Struct clap::Error

[+] Show declaration

pub struct Error {
    pub kind: ErrorKind,
    pub info: Vec<String>,
    // some fields omitted
}

[−] Expand description

Command Line Argument Parser Error

Fields

kind: ErrorKind

[−] Expand description

The type of error

info: Vec<String>

[−] Expand description

Additional information depending on the error kind, like values and argument names. Useful when you want to render an error of your own.

Implementations

impl Error[−]

pub fn use_stderr(&self) -> bool[−]

Should the message be written to stdout or not

pub fn exit(&self) -> ![−]

Prints the error to stderr and exits with a status of 1

pub fn with_description(description: String, kind: ErrorKind) -> Self[−]

Create an error with a custom description.

This can be used in combination with Error::exit to exit your program with a custom error message.

Trait Implementations

impl Debug for Error[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for Error[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Error for Error[+]

[+] Show hidden undocumented items

fn source(&self) -> Option<&(dyn Error + 'static)>[−]

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>[−]

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str[−]

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for Error[+]

[+] Show hidden undocumented items

fn from(e: Error) -> Self[−]

Performs the conversion.

impl From<Error> for Error[+]

[+] Show hidden undocumented items

fn from(e: Error) -> Self[−]

Performs the conversion.