bpaf 0.9.25

A simple Command Line Argument Parser with parser combinators
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101


```no_run
use bpaf::*;

pub fn options() -> OptionParser<f64> {
    let miles = long("miles").help("Distance in miles").argument("MI");
    let km = long("kilo").help("Distance in kilometers").argument("KM");
    construct!([miles, km]).to_options()
}

fn main() {
    println!("{:?}", options().run())
}
```

<details><summary>Output</summary>

Help message describes all the parser combined

<div class='bpaf-doc'>
$ app --help<br>
<p><b>Usage</b>: <tt><b>app</b></tt> (<tt><b>--miles</b></tt>=<tt><i>MI</i></tt> | <tt><b>--kilo</b></tt>=<tt><i>KM</i></tt>)</p><p><div>
<b>Available options:</b></div><dl><dt><tt><b>    --miles</b></tt>=<tt><i>MI</i></tt></dt>
<dd>Distance in miles</dd>
<dt><tt><b>    --kilo</b></tt>=<tt><i>KM</i></tt></dt>
<dd>Distance in kilometers</dd>
<dt><tt><b>-h</b></tt>, <tt><b>--help</b></tt></dt>
<dd>Prints help information</dd>
</dl>
</p>
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: "Source Code Pro", monospace;
    margin-bottom: 0.75em;
}
div.bpaf-doc dt { margin-left: 1em; }
div.bpaf-doc dd { margin-left: 3em; }
div.bpaf-doc dl { margin-top: 0; padding-left: 1em; }
div.bpaf-doc  { padding-left: 1em; }
</style>
</div>


Users can pass value that satisfy either parser


<div class='bpaf-doc'>
$ app --miles 42<br>
42.0
</div>


<div class='bpaf-doc'>
$ app --kilo 15<br>
15.0
</div>


But not both at once or not at all:


<div class='bpaf-doc'>
$ app --miles 53 --kilo 10<br>
<b>Error:</b> <tt><b>--kilo</b></tt> cannot be used at the same time as <tt><b>--miles</b></tt>
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: "Source Code Pro", monospace;
    margin-bottom: 0.75em;
}
div.bpaf-doc dt { margin-left: 1em; }
div.bpaf-doc dd { margin-left: 3em; }
div.bpaf-doc dl { margin-top: 0; padding-left: 1em; }
div.bpaf-doc  { padding-left: 1em; }
</style>
</div>


<div class='bpaf-doc'>
$ app <br>
<b>Error:</b> expected <tt><b>--miles</b></tt>=<tt><i>MI</i></tt> or <tt><b>--kilo</b></tt>=<tt><i>KM</i></tt>, pass <tt><b>--help</b></tt> for usage information
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: "Source Code Pro", monospace;
    margin-bottom: 0.75em;
}
div.bpaf-doc dt { margin-left: 1em; }
div.bpaf-doc dd { margin-left: 3em; }
div.bpaf-doc dl { margin-top: 0; padding-left: 1em; }
div.bpaf-doc  { padding-left: 1em; }
</style>
</div>


If those cases are valid you can handle them with `optional` and `many`
</details>