[][src]Crate argwerk

Documentation Crates Actions Status

Helper utility for parsing simple commandline arguments.

This is not intended to be a complete commandline parser library. Instead this can be used as an alternative quick-and-dirty approach that can be cheaply incorporated into a tool.

For a more complete commandline parsing library, use clap.

Examples

This is available as a runnable example:

cargo run --example basic
let args = argwerk::argwerk! {
    /// A simple test command.
    ///
    /// This is nice!
    "testcommand [-h]" {
        help: bool,
        file: Option<String>,
        limit: usize = 42,
    }
    /// Print this help.
    "-h" | "--help" => {
        help = true;
        print_help();
        Ok(())
    }
    /// Limit the number of things by <n>.
    "--limit" | "-l", n => {
        limit = str::parse(&n)?;
        Ok(())
    }
    /// Write to the file specified by <path>.
    "--file", path if !file.is_some() => {
        file = Some(path);
        Ok(())
    }
}?;

if args.help {
    return Ok(());
}

Ok(())

Macros

argwerk

Parse commandline arguments.

Structs

Doc

Helper utility for building documentation.

Error

An error raised by argwerk.

Enums

ErrorKind

The kind of an error.