bpaf 0.9.20

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
130

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

```no_run
use std::{fmt::Display as _, path::PathBuf};
fn try_to_get_log_file() -> Result<PathBuf, &'static str> {
    Ok(PathBuf::from("logfile.txt"))
}

#[derive(Debug, Clone)]
pub struct Options {
    log_file: PathBuf,
}

pub fn options() -> OptionParser<Options> {
    let log_file = long("log-file")
        .help("Path to log file")
        .argument::<PathBuf>("FILE")
        .guard(
            |log_file| !log_file.is_dir(),
            "The log file can't be a directory",
        )
        .fallback_with(try_to_get_log_file)
        .format_fallback(|path, f| path.display().fmt(f));
    construct!(Options { log_file }).to_options()
}

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

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

```no_run
use std::{fmt::Display as _, path::PathBuf};
fn try_to_get_log_file() -> Result<PathBuf, &'static str> {
    Ok(PathBuf::from("logfile.txt"))
}

#[derive(Debug, Clone, Bpaf)]
#[bpaf(options)]
pub struct Options {
    /// Path to log file
    #[bpaf(
        argument("FILE"),
        guard(|log_file| !log_file.is_dir(), "The log file can't be a directory"),
        fallback_with(try_to_get_log_file),
        format_fallback(|path, f| path.display().fmt(f)),
    )]
    log_file: PathBuf,
}

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

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

`fallback_with` changes parser to fallback to a value that comes from a potentially failing
computation when argument is not specified


<div class='bpaf-doc'>
$ app <br>
Options { log_file: "logfile.txt" }
</div>


If value is present - fallback value is ignored


<div class='bpaf-doc'>
$ app --log-file output.txt<br>
Options { log_file: "output.txt" }
</div>


Parsing errors are preserved and presented to the user


<div class='bpaf-doc'>
$ app --log-file /<br>
<b>Error:</b> <b>/</b>: The log file can't be a directory
<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>


`bpaf` encases parsers with fallback value of some sort in usage with `[]`


<div class='bpaf-doc'>
$ app --help<br>
<p><b>Usage</b>: <tt><b>app</b></tt> [<tt><b>--log-file</b></tt>=<tt><i>FILE</i></tt>]</p><p><div>
<b>Available options:</b></div><dl><dt><tt><b>    --log-file</b></tt>=<tt><i>FILE</i></tt></dt>
<dd>Path to log file</dd>
<dt></dt>
<dd>[default: logfile.txt]</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>

</details>