Google Git
Sign in
android / platform / external / rust / crates / structopt / refs/heads/android13-qpr2-release / . / examples
tree: fabbabe476316d9d33714f8fbd1f870f72c4b792 [path history] [tgz]
  1. after_help.rs
  2. at_least_two.rs
  3. basic.rs
  4. deny_missing_docs.rs
  5. doc_comments.rs
  6. enum_in_args.rs
  7. enum_in_args_with_strum.rs
  8. enum_tuple.rs
  9. env.rs
  10. example.rs
  11. flatten.rs
  12. gen_completions.rs
  13. git.rs
  14. group.rs
  15. keyvalue.rs
  16. negative_flag.rs
  17. no_version.rs
  18. README.md
  19. rename_all.rs
  20. required_if.rs
  21. skip.rs
  22. subcommand_aliases.rs
  23. true_or_false.rs
examples/README.md

Collection of examples “how to use structopt”

Help on the bottom

How to append a postscript to the help message generated.

At least N

How to require presence of at least N values, like val1 val2 ... valN ... valM.

Basic

A basic example how to use structopt.

Deny missing docs

This is not an example but a test, it should be moved to tests folder as soon as this is fixed (if ever).

Doc comments

How to use doc comments in place of help/long_help.

Enums as arguments

How to use arg_enum! with StructOpt.

Arguments of subcommands in separate struct

How to extract subcommands' args into external structs.

Environment variables

How to use environment variable fallback and how it interacts with default_value.

Advanced

Somewhat complex example of usage of structopt.

Flatten

How to use #[structopt(flatten)]

bash completions

Generating bash completions with structopt.

Git

Pseudo-git example, shows how to use subcommands and how to document them.

Groups

Using clap::Arg::group with structopt.

key=value pairs

How to parse key=value pairs.

--no-* flags

How to add no-thing flag which is true by default and false if passed.

No version

How to completely remove version.

Rename all

How #[structopt(rename_all)] works.

Required If

How to use #[structopt(required_if)].

Skip

How to use #[structopt(skip)].

Aliases

How to use aliases

true or false

How to express ""true" or "false" argument.