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
//! A somewhat comprehensive example of a typical combinatoric `bpaf` usage.
use bpaf::*;
use std::path::PathBuf;
#[allow(dead_code)]
#[derive(Debug, Clone)]
struct Out {
debug: bool,
verbose: usize,
speed: f64,
output: PathBuf,
nb_cars: u32,
files_to_process: Vec<PathBuf>,
}
fn opts() -> OptionParser<Out> {
// A flag, true if used in the command line. Can be required, this one is optional
let debug = short('d') // start with a short name
.long("debug") // also add a long name
.help("Activate debug mode") // and a help message to use
.switch(); // turn this into a switch
// number of occurrences of the v/verbose flag capped at 3 with an error here but you can also
// use `max` inside `map`
let verbose = short('v')
.long("verbose")
.help("Increase the verbosity\nYou can specify it up to 3 times\neither as -v -v -v or as -vvv")
.req_flag(())
.many()
.map(|xs| xs.len())
.guard(|&x| x <= 3, "It doesn't get any more verbose than this");
// an argument, parsed and with default value
let speed = short('s')
.long("speed")
.help("Set speed")
.argument::<f64>("SPEED") // you can specify a type to parse
.fallback(42.0);
let output = short('o')
.long("output")
.help("output file")
.argument::<PathBuf>("OUTPUT") // but it's optional when rustc can derive it
.complete_shell(ShellComp::File { mask: None });
// no magical name transmogrifications in combinatoric API,
let nb_cars = short('n').long("nb-cars").argument::<u32>("N");
// a parser that consumes one argument
// you can build the inner parser in one go or as multiple steps giving each step a name
// you can also add some static shell completion functionality
let file_to_proces = short('f')
.long("file")
.help("File to process")
.argument::<PathBuf>("FILE")
.complete_shell(ShellComp::File { mask: Some("*.rs") });
let files_to_process = file_to_proces.many();
// packing things in a struct assumes parser for each field is in scope.
construct!(Out {
debug,
verbose,
speed,
output,
nb_cars,
files_to_process
})
.to_options()
.descr("This is a description")
}
fn main() {
let opts = opts().run();
println!("{:#?}", opts);
}