pub struct Error {
pub message: String,
pub kind: ErrorKind,
pub info: Option<Vec<String>>,
}
Expand description
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§
source§impl Error
impl Error
sourcepub fn use_stderr(&self) -> bool
pub fn use_stderr(&self) -> bool
Should the message be written to stdout
or not
sourcepub fn exit(&self) -> !
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
.
sourcepub fn with_description(description: &str, kind: ErrorKind) -> Self
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§
source§impl Error for Error
impl Error for Error
source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
Auto Trait Implementations§
impl Freeze for Error
impl RefUnwindSafe for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more