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
102
103
104
105
106
107
108
109
110
111
112
113
114
115


```no_run
#[derive(Debug, Clone, Bpaf)]
#[bpaf(options)]
pub enum Options {
    File {
        /// Read input from a file
        name: String,
    },

    Url {
        /// Read input from URL
        url: String,
        /// Authentication method to use for the URL
        auth_method: String,
    },
}

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

<details><summary>Output</summary>

Help message reflects mutually exclusive parts


<div class='bpaf-doc'>
$ app --help<br>
<p><b>Usage</b>: <tt><b>app</b></tt> (<tt><b>--name</b></tt>=<tt><i>ARG</i></tt> | <tt><b>--url</b></tt>=<tt><i>ARG</i></tt> <tt><b>--auth-method</b></tt>=<tt><i>ARG</i></tt>)</p><p><div>
<b>Available options:</b></div><dl><dt><tt><b>    --name</b></tt>=<tt><i>ARG</i></tt></dt>
<dd>Read input from a file</dd>
<dt><tt><b>    --url</b></tt>=<tt><i>ARG</i></tt></dt>
<dd>Read input from URL</dd>
<dt><tt><b>    --auth-method</b></tt>=<tt><i>ARG</i></tt></dt>
<dd>Authentication method to use for the URL</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>


At least one branch needs to succeed


<div class='bpaf-doc'>
$ app <br>
<b>Error:</b> expected <tt><b>--name</b></tt>=<tt><i>ARG</i></tt> or <tt><b>--url</b></tt>=<tt><i>ARG</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>


And in this example only one branch can succeed


<div class='bpaf-doc'>
$ app --name Cargo.toml<br>
File { name: "Cargo.toml" }
</div>



<div class='bpaf-doc'>
$ app --url https://crates.io --auth-method digest<br>
Url { url: "https://crates.io", auth_method: "digest" }
</div>


While both branches can succeed at once - only one will actually succeed and afetr that
parsing fails since there are unconsumed items


<div class='bpaf-doc'>
$ app --url https://crates.io --auth-method digest --name Cargo.toml<br>
<b>Error:</b> <tt><b>--name</b></tt> cannot be used at the same time as <tt><b>--url</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>

</details>