Struct clap::Error [−][src]
Expand description
Command Line Argument Parser Error
See App::error
to create an error.
Fields
kind: ErrorKind
The type of error
info: Vec<String>
Additional information depending on the error kind, like values and argument names. Useful when you want to render an error of your own.
Implementations
Create an unformatted error
This is for you need to pass the error up to
a place that has access to the App
at which point you can call Error::format]. Prefer [
App::error` for generating errors.
Format the existing message with the App’s context
Should the message be written to stdout
or not?
Prints the error and exits.
Depending on the error kind, this either prints to stderr
and exits with a status of 1
or prints to stdout
and exits with a status of 0
.
Prints formatted and colored error to stdout
or stderr
according to its error kind
Example
use clap::App;
match App::new("App").try_get_matches() {
Ok(matches) => {
// do_something
},
Err(err) => {
err.print().expect("Error writing Error");
// do_something
},
};
👎 Deprecated since 3.0.0: Replaced with App::error
Replaced with App::error
Deprecated, replaced with App::error