pound 0.1.6

low footprint, derive-first CLI 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

// SPDX-License-Identifier: EUPL-1.2

//! the single parse error type, plus the help/version early-exit signals.
//! `Display` is hand-written, no derive dependency.

use core::fmt;

#[cfg(not(feature = "std"))]
use crate::alloc_prelude::*;

/// anything a parse attempt can produce.
///
/// [`Self::Help`] and [`Self::Version`] are not failures, they carry rendered
/// text and mean "print this and exit 0". the `parse*` entry points handle
/// that, the `try_parse*` ones leave it to you.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Error {
    /// unrecognised `--flag` or `-x`
    Unknown(String),
    /// an option that takes a value got none
    MissingValue(String),
    /// a required arg or positional was absent
    MissingRequired(String),
    /// a bare value with nowhere to go
    UnexpectedPositional(String),
    /// a flag was given a value (e.g. `--verbose=3`) but takes none
    UnexpectedValue(String),
    /// first positional named a subcommand that does not exist
    UnknownSubcommand(String),
    /// a subcommand was required but none given
    MissingSubcommand,
    /// a value failed to parse into its target type
    Value {
        arg:   String,
        value: String,
        msg:   String,
    },
    /// two members of a mutually-exclusive group were both set
    Conflict {
        group:  String,
        first:  String,
        second: String,
    },
    /// a required group had none of its members set
    MissingGroup { group: String, options: String },
    /// `-h` / `--help`, payload is rendered help
    Help(String),
    /// `--version`, payload is the version line
    Version(String),
}

impl Error {
    /// true for the two non-failure signals.
    #[must_use]
    pub const fn is_exit(&self) -> bool {
        matches!(*self, Self::Help(_) | Self::Version(_))
    }

    /// print to the right stream and exit: help/version to stdout with 0, real
    /// errors to stderr with 2.
    #[cfg(feature = "std")]
    pub fn exit(self) -> ! {
        match self {
            Self::Help(text) | Self::Version(text) => {
                println!("{text}");
                std::process::exit(0);
            },
            other => {
                eprintln!("error: {other}");
                std::process::exit(2);
            },
        }
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Unknown(a) => write!(f, "unrecognised argument '{a}'"),
            Self::MissingValue(a) => write!(f, "'{a}' needs a value"),
            Self::MissingRequired(a) => write!(f, "missing required argument {a}"),
            Self::UnexpectedPositional(v) => write!(f, "unexpected argument '{v}'"),
            Self::UnexpectedValue(a) => write!(f, "'{a}' does not take a value"),
            Self::UnknownSubcommand(s) => write!(f, "unknown subcommand '{s}'"),
            Self::MissingSubcommand => write!(f, "a subcommand is required"),
            Self::Value { arg, value, msg } => {
                write!(f, "invalid value '{value}' for {arg}: {msg}")
            },
            Self::Conflict {
                group,
                first,
                second,
            } => {
                if group.is_empty() {
                    write!(f, "{first} and {second} cannot be used together")
                } else {
                    write!(f, "{first} and {second} cannot be used together ({group})")
                }
            },
            Self::MissingGroup { group, options } => {
                write!(f, "one of {options} is required ({group})")
            },
            Self::Help(text) | Self::Version(text) => write!(f, "{text}"),
        }
    }
}

impl core::error::Error for Error {}