immargs 0.1.4

No-hassle, on-the-spot, command line argument parser
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

/// Convenience macro for on-the-spot command line argument parsing.
///
/// Parses arguments provided by caller, returns a [`Result`]`<T>`,
/// where `T` is an anonymous `struct`.
///
/// Example:
///
/// ```
/// use immargs::args_try_from;
///
/// let cmd_line_args = ["test", "-l8", "src", "dest"];
///
/// let args = args_try_from! {
///     cmd_line_args,
///     --force               "overwrite destination",
///     -l --log <level> u8   "set log level",
///     -h --help             "print help message",
///     <src>... String       "source(s)",
///     <dest> String         "destination",
/// };
///```
#[macro_export]
macro_rules! args_try_from {
    ($args:expr, $($spec:tt)*) => {{
        ::immargs::args! {
            Args,
            $($spec)*
        }
        Args::try_from($args)
    }};
}

/// Convenience macro for on-the-spot command line argument parsing.
///
/// Parses arguments provided by [`std::env::args_os()`], returns a [`Result`]`<T>`,
/// where `T` is an anonymous `struct`.
///
/// Example:
///
/// ```no_run
/// use immargs::args_try_from_env;
///
/// let args = args_try_from_env! {
///     --force               "overwrite destination",
///     -l --log <level> u8   "set log level",
///     -h --help             "print help message",
///     <src>... String       "source(s)",
///     <dest> String         "destination",
/// };
/// ```
#[macro_export]
macro_rules! args_try_from_env {
    ($($spec:tt)*) => {{
        ::immargs::args! {
            Args,
            $($spec)*
        }
        Args::try_from_env()
    }};
}

/// Convenience macro for on-the-spot command line argument parsing.
///
/// Parses arguments provided by the caller, returns an anonymous `struct`.
///
/// Example:
///
/// ```
/// use immargs::args_from;
///
/// let cmd_line_args = ["test", "-l8", "src", "dest"];
///
/// let args = args_from! {
///     cmd_line_args,
///     --force               "overwrite destination",
///     -l --log <level> u8   "set log level",
///     -h --help             "print help message",
///     <src>... String       "source(s)",
///     <dest> String         "destination",
/// };
/// ```
#[macro_export]
macro_rules! args_from {
    ($args:expr, $($spec:tt)*) => {{
        ::immargs::args! {
            Args,
            $($spec)*
        }
        Args::from($args)
    }};
}

/// Convenience macro for on-the-spot command line argument parsing.
///
/// Parses arguments provided by [`std::env::args_os()`], returns an
/// anonymous `struct`.
///
/// Example:
///
/// ```no_run
/// use immargs::args_from_env;
///
/// let args = args_from_env! {
///     --force               "overwrite destination",
///     -l --log <level> u8   "set log level",
///     -h --help             "print help message",
///     <src>... String       "source(s)",
///     <dest> String         "destination",
/// };
/// ```
#[macro_export]
macro_rules! args_from_env {
    ($($spec:tt)*) => {{
        ::immargs::args! {
            Args,
            $($spec)*
        }
        Args::from_env()
    }};
}