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
116
117
118
119
120
121
122
123
124
125
126
127
128
129

<details><summary>Combinatoric example</summary>

```no_run
#[derive(Debug, Clone)]
pub struct Options {
    multi_arg: Option<MultiArg>,
    turbo: bool,
}

#[derive(Debug, Clone)]
pub struct MultiArg {
    set: (),
    name: String,
    value: String,
}

pub fn options() -> OptionParser<Options> {
    let set = long("set").req_flag(());
    let name = positional("NAME").help("Name for the option");
    let value = positional("VAL").help("Value to set");
    let multi_arg = construct!(MultiArg { set, name, value })
        .adjacent()
        .optional();

    let turbo = long("turbo").switch();
    construct!(Options { multi_arg, turbo }).to_options()
}
```

</details>
<details><summary>Derive example</summary>

```no_run
#[derive(Debug, Clone, Bpaf)]
#[bpaf(options)]
pub struct Options {
    #[bpaf(external, optional)]
    multi_arg: Option<MultiArg>,
    turbo: bool,
}

#[derive(Debug, Clone, Bpaf)]
#[bpaf(adjacent)]
pub struct MultiArg {
    #[bpaf(long)]
    set: (),
    #[bpaf(positional("NAME"))]
    /// Name for the option
    name: String,
    #[bpaf(positional("VAL"))]
    /// Value to set
    value: String,
}
```

</details>
<details><summary>Output</summary>


<div class='bpaf-doc'>
$ app --help<br>
<p><b>Usage</b>: <tt><b>app</b></tt> [<tt><b>--set</b></tt> <tt><i>NAME</i></tt> <tt><i>VAL</i></tt>] [<tt><b>--turbo</b></tt>]</p><p><div>
<b>Available options:</b></div><dl><tt><b>--set</b></tt> <tt><i>NAME</i></tt> <tt><i>VAL</i></tt><dt><tt><i>NAME</i></tt></dt>
<dd>Name for the option</dd>
<dt><tt><i>VAL</i></tt></dt>
<dd>Value to set</dd>
<p></p><dt><tt><b>    --turbo</b></tt></dt>
<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: mono;
    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>


? It's possible to implement multi argument options by using required flag followed by one or
? more positional items

<div class='bpaf-doc'>
$ app --turbo --set name Bob<br>
Options { multi_arg: Some(MultiArg { set: (), name: "name", value: "Bob" }), turbo: true }
</div>

OK
Options { multi_arg: Some(MultiArg { set: (), name: "name", value: "Bob" }), turbo: true }

? Other flags can go on either side of items

<div class='bpaf-doc'>
$ app --set name Bob --turbo<br>
Options { multi_arg: Some(MultiArg { set: (), name: "name", value: "Bob" }), turbo: true }
</div>

OK
Options { multi_arg: Some(MultiArg { set: (), name: "name", value: "Bob" }), turbo: true }

? But not in between

<div class='bpaf-doc'>
$ app --set name --turbo Bob<br>
Expected <tt><i>VAL</i></tt>, got <b>--turbo</b>. Pass <tt><b>--help</b></tt> for usage information
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: mono;
    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>

Stderr
Expected <VAL>, got "--turbo". Pass --help for usage information
</details>