getargs-derive 0.1.0

Clap-style #[derive] command-line argument parser for no_std and embedded Rust: zero allocation, compile-time help, subcommands. Built on getargs.
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

#![allow(dead_code)]

use getargs_derive::{Error, GetArgs, Opt};

#[derive(Debug, GetArgs)]
struct FlagActions {
    #[arg(short, long, action = Count)]
    verbose: u8,
    #[arg(short = 'q', action = ArgAction::Count)]
    quiet: u32,
    #[arg(long, action = SetFalse)]
    no_color: bool,
    #[arg(long = "fast", action = SetTrue)]
    fast: bool,
    #[arg(long, action = Count, default_value_t = 3)]
    level: i64,
}

#[test]
fn flag_actions_defaults() {
    let params = FlagActions::from_args([].into_iter()).unwrap();
    assert_eq!(params.verbose, 0);
    assert_eq!(params.quiet, 0);
    assert!(params.no_color);
    assert!(!params.fast);
    assert_eq!(params.level, 3);
}

#[test]
fn count_action_counts_occurrences() {
    let args = ["-vvv", "--verbose", "-q", "-vq", "--level", "--level"];
    let params = FlagActions::from_args(args.into_iter()).unwrap();
    assert_eq!(params.verbose, 5);
    assert_eq!(params.quiet, 2);
    assert_eq!(params.level, 2);
}

#[test]
fn count_action_saturates() {
    let args = ["-v"; 300];
    let params = FlagActions::from_args(args.into_iter()).unwrap();
    assert_eq!(params.verbose, u8::MAX);
}

#[test]
fn set_false_and_set_true_actions() {
    let params = FlagActions::from_args(["--no-color", "--fast"].into_iter()).unwrap();
    assert!(!params.no_color);
    assert!(params.fast);
}

#[test]
fn count_action_rejects_value() {
    let err = FlagActions::from_args(["--verbose=2"].into_iter()).unwrap_err();
    assert_eq!(err, Error::UnexpectedValue(Opt::Long("verbose")));
}

#[derive(Debug, GetArgs)]
#[command(name = "actions")]
struct HelpActions {
    /// More output
    #[arg(short, long, action = Count)]
    verbose: u8,
    #[arg(short = 'q', action = Count, default_value_t = 1)]
    quiet: u8,
    /// Disable colors
    #[arg(long, action = SetFalse)]
    color: bool,
}

#[test]
fn help_actions_snapshot() {
    assert_eq!(
        HelpActions::HELP,
        "Usage: actions [OPTIONS]

Options:
  -v, --verbose...  More output
  -q...
      --color       Disable colors
  -h, --help        Print help"
    );
}