commit | cfc27afacabfe4f84f57092c5508e3dcd8d95a94 | [log] [tgz] |
---|---|---|
author | Matthew Maurer <mmaurer@google.com> | Fri Jun 05 15:28:00 2020 +0000 |
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | Fri Jun 05 15:28:00 2020 +0000 |
tree | 4d1d77009e1e028d57f76a1068e815029edb53d2 | |
parent | aec9a0556c1eaec17d51413dcd065e0d1d85711c [diff] | |
parent | 0ca5ae57f2479260bc3440fedc1cb02d87e8ecf2 [diff] |
Import structopt-0.3.14 am: 32e766957b am: 0ca5ae57f2 Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/structopt/+/1322972 Change-Id: I04a88df355a17e7b2ad61615d0cadf399576f834
Parse command line arguments by defining a struct. It combines clap with custom derive.
Find it on Docs.rs. You can also check the examples and the changelog.
Add structopt
to your dependencies of your Cargo.toml
:
[dependencies] structopt = "0.3"
And then, in your rust file:
use std::path::PathBuf; use structopt::StructOpt; /// A basic example #[derive(StructOpt, Debug)] #[structopt(name = "basic")] struct Opt { // A flag, true if used in the command line. Note doc comment will // be used for the help message of the flag. The name of the // argument will be, by default, based on the name of the field. /// Activate debug mode #[structopt(short, long)] debug: bool, // The number of occurrences of the `v/verbose` flag /// Verbose mode (-v, -vv, -vvv, etc.) #[structopt(short, long, parse(from_occurrences))] verbose: u8, /// Set speed #[structopt(short, long, default_value = "42")] speed: f64, /// Output file #[structopt(short, long, parse(from_os_str))] output: PathBuf, // the long option will be translated by default to kebab case, // i.e. `--nb-cars`. /// Number of cars #[structopt(short = "c", long)] nb_cars: Option<i32>, /// admin_level to consider #[structopt(short, long)] level: Vec<String>, /// Files to process #[structopt(name = "FILE", parse(from_os_str))] files: Vec<PathBuf>, } fn main() { let opt = Opt::from_args(); println!("{:#?}", opt); }
Using this example:
$ ./basic error: The following required arguments were not provided: --output <output> USAGE: basic --output <output> --speed <speed> For more information try --help $ ./basic --help basic 0.3.0 Guillaume Pinot <texitoi@texitoi.eu>, others A basic example USAGE: basic [FLAGS] [OPTIONS] --output <output> [--] [file]... FLAGS: -d, --debug Activate debug mode -h, --help Prints help information -V, --version Prints version information -v, --verbose Verbose mode (-v, -vv, -vvv, etc.) OPTIONS: -l, --level <level>... admin_level to consider -c, --nb-cars <nb-cars> Number of cars -o, --output <output> Output file -s, --speed <speed> Set speed [default: 42] ARGS: <file>... Files to process $ ./basic -o foo.txt Opt { debug: false, verbose: 0, speed: 42.0, output: "foo.txt", nb_cars: None, level: [], files: [], } $ ./basic -o foo.txt -dvvvs 1337 -l alice -l bob --nb-cars 4 bar.txt baz.txt Opt { debug: true, verbose: 3, speed: 1337.0, output: "foo.txt", nb_cars: Some( 4, ), level: [ "alice", "bob", ], files: [ "bar.txt", "baz.txt", ], }
cargo update
will not fail on StructOpt).Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.