Struct clap::Error

[+] Show declaration

pub struct Error {
    pub message: String,
    pub kind: ErrorKind,
    pub info: Option<Vec<String>>,
}

[−] Expand description

Command Line Argument Parser Error

Fields

message: String

[−] Expand description

Formatted error message

kind: ErrorKind

[−] Expand description

The type of error

info: Option<Vec<String>>

[−] Expand description

Any additional information passed along, such as the argument name that caused the error

Methods

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: &str, 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 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.

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 description(&self) -> &str[−]

This method is soft-deprecated.

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

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

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