Struct clap::Error[−][src]

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

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

Should the message be written to stdout or not

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

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

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

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[src][+]

impl Display for Error[src][+]

impl Error for Error[src][+]

impl From<Error> for Error[src][+]

impl From<Error> for Error[src][+]

Auto Trait Implementations

impl RefUnwindSafe for Error

impl Send for Error

impl Sync for Error

impl Unpin for Error

impl UnwindSafe for Error

Blanket Implementations

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

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

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

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

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

impl<T> ToString for T where
    T: Display + ?Sized, [src][+]

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.