aboutsummaryrefslogtreecommitdiff
path: root/clap/examples/01b_quick_example.rs
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2020-01-07 11:18:04 +0000
committerDaniel Mueller <deso@posteo.net>2020-01-08 09:20:25 -0800
commit5e20a29b4fdc8a2d442d1093681b396dcb4b816b (patch)
tree55ab083fa8999d2ccbb5e921c1ffe52560dca152 /clap/examples/01b_quick_example.rs
parent203e691f46d591a2cc8acdfd850fa9f5b0fb8a98 (diff)
downloadnitrocli-5e20a29b4fdc8a2d442d1093681b396dcb4b816b.tar.gz
nitrocli-5e20a29b4fdc8a2d442d1093681b396dcb4b816b.tar.bz2
Add structopt dependency in version 0.3.7
This patch series replaces argparse with structopt in the argument handling code. As a first step, we need structopt as a dependency. Import subrepo structopt/:structopt at efbdda4753592e27bc430fb01f7b9650b2f3174d Import subrepo bitflags/:bitflags at 30668016aca6bd3b02c766e8347e0b4080d4c296 Import subrepo clap/:clap at 784524f7eb193e35f81082cc69454c8c21b948f7 Import subrepo heck/:heck at 093d56fbf001e1506e56dbfa38631d99b1066df1 Import subrepo proc-macro-error/:proc-macro-error at 6c4cfe79a622c5de8ae68557993542be46eacae2 Import subrepo proc-macro2/:proc-macro2 at d5d48eddca4566e5438e8a2cbed4a74e049544de Import subrepo quote/:quote at 727436c6c137b20f0f34dde5d8fda2679b9747ad Import subrepo rustversion/:rustversion at 0c5663313516263059ce9059ef81fc7a1cf655ca Import subrepo syn-mid/:syn-mid at 5d3d85414a9e6674e1857ec22a87b96e04a6851a Import subrepo syn/:syn at e87c27e87f6f4ef8919d0372bdb056d53ef0d8f3 Import subrepo textwrap/:textwrap at abcd618beae3f74841032aa5b53c1086b0a57ca2 Import subrepo unicode-segmentation/:unicode-segmentation at 637c9874c4fe0c205ff27787faf150a40295c6c3 Import subrepo unicode-width/:unicode-width at 3033826f8bf05e82724140a981d5941e48fce393 Import subrepo unicode-xid/:unicode-xid at 4baae9fffb156ba229665b972a9cd5991787ceb7
Diffstat (limited to 'clap/examples/01b_quick_example.rs')
-rw-r--r--clap/examples/01b_quick_example.rs93
1 files changed, 93 insertions, 0 deletions
diff --git a/clap/examples/01b_quick_example.rs b/clap/examples/01b_quick_example.rs
new file mode 100644
index 0000000..7f455a8
--- /dev/null
+++ b/clap/examples/01b_quick_example.rs
@@ -0,0 +1,93 @@
+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 01a_quick_example.rs and 01c_quick_example.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.
+ //
+ // 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")
+ // - 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")
+ // - 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")
+ .short("c")
+ .long("config")
+ .value_name("FILE")
+ .help("Sets a custom config file")
+ .takes_value(true))
+ .arg(Arg::with_name("output")
+ .help("Sets an optional output file")
+ .index(1))
+ .arg(Arg::with_name("debug")
+ .short("d")
+ .multiple(true)
+ .help("Turn debugging information on"))
+ .subcommand(SubCommand::with_name("test")
+ .about("does testing things")
+ .arg(Arg::with_name("list")
+ .short("l")
+ .help("lists test values")))
+ .get_matches();
+
+ // 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);
+ }
+
+ if let Some(c) = matches.value_of("config") {
+ println!("Value for config: {}", c);
+ }
+
+ // 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"),
+ 1 => println!("Debug mode is kind of on"),
+ 2 => println!("Debug mode is on"),
+ 3 | _ => println!("Don't be crazy"),
+ }
+
+ // You can check for the existence of subcommands, and if found use their
+ // matches just as you would the top level app
+ if let Some(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...
+}