Enum Error 

pub enum Error {
    InvalidName(String),
    MissingValue(String),
    MissingHelpArg,
    InvalidUnicode,
}

Error types returned by the library.

Variants

InvalidName(String)

Returned when the parser detects an unregistered flag, option, or command name.

MissingValue(String)

Returned when the parser detects an option with a missing value.

MissingHelpArg

Returned when the parser detects a help command with a missing argument.

InvalidUnicode

Returned when the command line arguments are not valid unicode strings.

Implementations

impl Error

pub fn exit(self) -> !

Prints an error message to stderr and exits with a non-zero status code.

Examples found in repository

examples/command.rs (line 13)

fn main() {
    let mut parser = ArgParser::new()
        .helptext("Usage: foobar...")
        .version("1.0")
        .command("boo", ArgParser::new()
            .helptext("Usage: foobar boo...")
            .callback(cmd_boo)
        );

    if let Err(err) = parser.parse() {
        err.exit();
    }
}

examples/basic.rs (line 11)

fn main() {
    let mut parser = ArgParser::new()
        .helptext("Usage: foobar...")
        .version("1.0")
        .option("bar b", "default")
        .flag("foo f");

    if let Err(err) = parser.parse() {
        err.exit();
    }

    if parser.found("foo") {
        println!("Flag --foo/-f found.");
    }

    println!("Option --bar/-b has value: {}", parser.value("bar"));

    for arg in parser.args {
        println!("Arg: {}", arg);
    }
}

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 source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.