clap/examples/01b_quick_example.rs

93 lines
4.5 KiB
Rust
Raw Normal View History

2015-03-15 21:17:52 +00:00
extern crate clap;
use clap::{App, Arg, SubCommand};
fn main() {
// This method shows the traditional, and slightly more configurable way to set up arguments. This method is
// more verbose, but allows setting more configuration options, and even supports easier dynamic generation.
//
// The example below is functionally identical to the one in 01a_QuickExample.rs
//
// *NOTE:* You can actually achieve the best of both worlds by using Arg::from_usage() (instead of Arg::with_name())
// and *then* setting any additional properties.
//
2015-03-16 18:47:09 +00:00
// Create an application with 5 possible arguments (2 auto generated) and 2 subcommands (1 auto generated)
// - A config file
// + Uses "-c filename" or "--config filename"
// - An output file
// + A positional argument (i.e. "$ myapp output_filename")
// - A debug flag
// + Uses "-d" or "--debug"
// + Allows multiple occurrences of such as "-dd" (for vary levels of debugging, as an example)
// - A help flag (automatically generated by clap)
// + Uses "-h" or "--help" (Only autogenerated if you do NOT specify your own "-h" or "--help")
// - A version flag (automatically generated by clap)
// + Uses "-V" or "--version" (Only autogenerated if you do NOT specify your own "-V" or "--version")
2015-03-16 18:47:09 +00:00
// - A subcommand "test" (subcommands behave like their own apps, with their own arguments
// + Used by "$ myapp test" with the following arguments
// > A list flag
// = Uses "-l" (usage is "$ myapp test -l"
// > A help flag (automatically generated by clap
// = Uses "-h" or "--help" (full usage "$ myapp test -h" or "$ myapp test --help")
// > A version flag (automatically generated by clap
// = Uses "-V" or "--version" (full usage "$ myapp test -V" or "$ myapp test --version")
2015-03-16 18:47:09 +00:00
// - A subcommand "help" (automatically generated by clap because we specified a subcommand of our own)
// + Used by "$ myapp help" (same functionality as "-h" or "--help")
let matches = App::new("MyApp")
.version("1.0")
.author("Kevin K. <kbknapp@gmail.com>")
.about("Does awesome things")
.arg(Arg::with_name("config")
2015-03-16 18:47:09 +00:00
.short("c")
.long("config")
.help("Sets a custom config file")
.takes_value(true))
.arg(Arg::with_name("output")
2015-03-16 18:47:09 +00:00
.help("Sets an optional output file")
.index(1))
.arg(Arg::with_name("debug")
2015-03-16 18:47:09 +00:00
.short("d")
.multiple(true)
2015-03-16 18:47:09 +00:00
.help("Turn debugging information on"))
.subcommand(SubCommand::with_name("test")
2015-03-16 18:47:09 +00:00
.about("does testing things")
.arg(Arg::with_name("list")
.short("l")
.help("lists test values")))
2015-03-16 18:47:09 +00:00
.get_matches();
2015-03-15 21:17:52 +00:00
2015-03-16 18:47:09 +00:00
// You can check the value provided by positional arguments, or option arguments
if let Some(o) = matches.value_of("output") {
println!("Value for output: {}", o);
}
2015-03-15 21:17:52 +00:00
2015-03-16 18:47:09 +00:00
if let Some(c) = matches.value_of("config") {
println!("Value for config: {}", c);
}
2015-03-15 21:17:52 +00:00
2015-03-16 18:47:09 +00:00
// You can see how many times a particular flag or argument occurred
// Note, only flags can have multiple occurrences
match matches.occurrences_of("debug") {
0 => println!("Debug mode is off"),
2015-03-16 18:47:09 +00:00
1 => println!("Debug mode is kind of on"),
2 => println!("Debug mode is on"),
3 | _ => println!("Don't be crazy"),
}
2015-03-15 21:17:52 +00:00
// You can check for the existence of subcommands, and if found use their
2015-03-16 18:47:09 +00:00
// matches just as you would the top level app
if let Some(ref matches) = matches.subcommand_matches("test") {
// "$ myapp test" was run
if matches.is_present("list") {
// "$ myapp test -l" was run
println!("Printing testing lists...");
} else {
println!("Not printing testing lists...");
}
}
// Continued program logic goes here...
}