Struct clap::Error

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

Command Line Argument Parser Error

Fields

message: String

Formatted error message

kind: ErrorKind

The type of error

info: Option<Vec<String>>

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

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 message and exits. If Error::use_stderr evaluates to true, the message will be written to stderr and exits with a status of 1. Otherwise, stdout is used with a status of 0.

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 Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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 cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.