[−][src]Crate argwerk
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.
We provide:
- A dependency-free commandline parsing framework using declarative macros.
- A flexible mechanism for parsing.
- Formatting of decent looking help messages.
We do not provide:
- As-close-to correct line wrapping with wide unicode characters as possible (see textwrap).
- Required switches and arguments. If your switch is required, you'll have
to ok_or_else it yourself from an
Option<T>
. - Complex command structures like subcommands.
- Parsing into OsStrings. The default parser will panic in case not valid unicode is passed into it in accordance with std::env::args.
For how to use, see the documentation of argwerk::parse!.
Examples
This is available as a runnable example:
cargo run --example tour
let args = argwerk::parse! { /// A command touring the capabilities of argwerk. "tour [-h]" { help: bool, file: Option<String>, input: Option<String>, limit: usize = 10, positional: Option<(String, Option<String>)>, rest: Vec<String>, } /// Prints the help. /// /// This includes: /// * All the available switches. /// * All the available positional arguments. /// * Whatever else the developer decided to put in here! We even support wrapping comments which are overly long. ["-h" | "--help"] => { help = true; } /// Limit the number of things by <n> (default: 10). ["--limit" | "-l", n] => { limit = str::parse(&n)?; } /// Write to the file specified by <path>. ["--file", path] if !file.is_some() => { file = Some(path); } /// Read from the specified input. ["--input", #[option] path] => { input = path; } /// Takes argument at <foo> and <bar>. /// /// * This is an indented message. The first alphanumeric character determines the indentation to use. [foo, #[option] bar, #[rest] args] if positional.is_none() => { positional = Some((foo, bar)); rest = args; } }?; if args.help { println!("{}", args.help()); } dbg!(args);
Macros
parse | Parse commandline arguments. |
Structs
Error | An error raised by argwerk. |
Help | Helper that can be formatted into documentation text. |
HelpFormat | A wrapper to format the help message with custom parameters. |
Switch | Documentation over a single switch. |
Enums
ErrorKind | The kind of an error. |