• Home
Name
Date
Size
#Lines
LOC

..--

README.mdD03-May-20241.9 KiB8744

after_help.rsD03-May-2024405 2011

at_least_two.rsD03-May-2024308 1610

basic.rsD03-May-20241.3 KiB4924

deny_missing_docs.rsD03-May-20241.2 KiB5226

doc_comments.rsD03-May-20242.2 KiB7532

enum_in_args.rsD03-May-2024426 2619

enum_tuple.rsD03-May-2024502 2720

env.rsD03-May-2024767 2713

example.rsD03-May-20241.7 KiB5522

flatten.rsD03-May-2024485 3019

gen_completions.rsD03-May-2024792 2712

git.rsD03-May-2024880 3625

group.rsD03-May-2024725 3221

keyvalue.rsD03-May-20241 KiB3723

negative_flag.rsD03-May-2024327 1610

no_version.rsD03-May-2024326 1813

rename_all.rsD03-May-20242.7 KiB7931

required_if.rsD03-May-20241.1 KiB4434

skip.rsD03-May-2024843 4839

subcommand_aliases.rsD03-May-2024583 2214

true_or_false.rsD03-May-20241.1 KiB4228

README.md

1# Collection of examples "how to use `structopt`"
2
3### [Help on the bottom](after_help.rs)
4
5How to append a postscript to the help message generated.
6
7### [At least N](at_least_two.rs)
8
9How to require presence of at least N values, like `val1 val2 ... valN ... valM`.
10
11### [Basic](basic.rs)
12
13A basic example how to use `structopt`.
14
15### [Deny missing docs](deny_missing_docs.rs)
16
17**This is not an example but a test**, it should be moved to `tests` folder
18as soon as [this](https://github.com/rust-lang/rust/issues/24584) is fixed (if ever).
19
20### [Doc comments](doc_comments.rs)
21
22How to use doc comments in place of `help/long_help`.
23
24### [Enums as arguments](enum_in_args.rs)
25
26How to use `arg_enum!` with `StructOpt`.
27
28### [Arguments of subcommands in separate `struct`](enum_tuple.rs)
29
30How to extract subcommands' args into external structs.
31
32### [Environment variables](env.rs)
33
34How to use environment variable fallback an how it interacts with `default_value`.
35
36### [Advanced](example.rs)
37
38Somewhat complex example of usage of `structopt`.
39
40### [Flatten](flatten.rs)
41
42How to use `#[structopt(flatten)]`
43
44### [`bash` completions](gen_completions.rs)
45
46Generating `bash` completions with `structopt`.
47
48### [Git](git.rs)
49
50Pseudo-`git` example, shows how to use subcommands and how to document them.
51
52### [Groups](group.rs)
53
54Using `clap::Arg::group` with `structopt`.
55
56### [`key=value` pairs](keyvalue.rs)
57
58How to parse `key=value` pairs.
59
60### [`--no-*` flags](negative_flag.rs)
61
62How to add `no-thing` flag which is `true` by default and `false` if passed.
63
64### [No version](no_version.rs)
65
66How to completely remove version.
67
68### [Rename all](rename_all.rs)
69
70How `#[structopt(rename_all)]` works.
71
72### [Required If](required_if.rs)
73
74How to use `#[structopt(required_if)]`.
75
76### [Skip](skip.rs)
77
78How to use `#[structopt(skip)]`.
79
80### [Aliases](subcommand_aliases.rs)
81
82How to use aliases
83
84### [`true` or `false`](true_or_false.rs)
85
86How to express "`"true"` or `"false"` argument.
87