kutil 0.0.5

Kutil utilities collection
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

use std::{error, fmt};

//
// ExitError
//

/// Simple exit error.
#[derive(Clone, Debug)]
pub struct ExitError {
    /// Exit code.
    pub code: u8,

    /// Optional goodbye message.
    pub message: Option<String>,
}

impl ExitError {
    /// Constructor.
    pub fn new(code: u8, message: Option<String>) -> Self {
        Self { code, message }
    }

    /// Constructor.
    pub fn new_from<ToStringT>(code: u8, to_string: ToStringT) -> Self
    where
        ToStringT: ToString,
    {
        Self::new(code, Some(to_string.to_string()))
    }

    /// Successful exit (code 0) without a message.
    pub fn success() -> Self {
        0.into()
    }
}

impl error::Error for ExitError {}

impl fmt::Display for ExitError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match &self.message {
            Some(message) => write!(formatter, "exit code {}: {}", self.code, message),
            None => Ok(()),
        }
    }
}

// Conversions

impl From<u8> for ExitError {
    fn from(value: u8) -> Self {
        Self::new(value, None)
    }
}

impl From<String> for ExitError {
    fn from(message: String) -> Self {
        Self::new(1, Some(message))
    }
}

impl From<&str> for ExitError {
    fn from(message: &str) -> Self {
        message.to_string().into()
    }
}

/// Handle an [ExitError] enum variant by implementing [RunError](super::RunError).
#[macro_export]
macro_rules! handle_exit_error {
    ( $error_enum:ty, $exit_error_variant:ident $(,)? ) => {
        impl $crate::cli::run::RunError for $error_enum {
            fn handle(&self) -> (bool, u8) {
                (
                    false,
                    match self {
                        Self::$exit_error_variant(exit_error) => exit_error.code,
                        _ => 1,
                    },
                )
            }
        }
    };
}

#[allow(unused_imports)]
pub use handle_exit_error;