proc-exit 0.2.0

Exit codes for process termination
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

use std::io::Write;

/// Error type for exiting programs.
pub struct Exit {
    code: crate::Code,
    msg: Option<Box<dyn std::fmt::Display>>,
}

impl Exit {
    pub fn new(code: crate::Code) -> Self {
        Self {
            code: code,
            msg: None,
        }
    }

    pub fn with_message<D: std::fmt::Display + 'static>(mut self, msg: D) -> Self {
        self.msg = Some(Box::new(msg));
        self
    }
}

impl std::fmt::Display for Exit {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        if let Some(msg) = self.msg.as_ref() {
            msg.fmt(f)
        } else {
            Ok(())
        }
    }
}

impl std::fmt::Debug for Exit {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        // For compatibility with `std::process::Termination`
        std::fmt::Display::fmt(self, f)
    }
}

impl From<std::io::Error> for Exit {
    fn from(err: std::io::Error) -> Self {
        Self::new(err.kind().into()).with_message(err)
    }
}

/// Extension for converting errors to `Exit`.
pub trait WithCodeResultExt<T> {
    /// Convert an Error into an `Exit`
    fn with_code(self, code: crate::Code) -> Result<T, Exit>;
}

impl<T, E: std::fmt::Display + 'static> WithCodeResultExt<T> for Result<T, E> {
    fn with_code(self, code: crate::Code) -> Result<T, Exit> {
        self.map_err(|e| Exit::new(code).with_message(e))
    }
}

/// Extension for `main()` functions`.
pub trait ProcessExitResultExt {
    /// Report any error message and exit.
    fn process_exit(self) -> !;

    /// Report, delegating exiting to the caller.
    fn report(self) -> crate::Code;
}

impl ProcessExitResultExt for Result<(), Exit> {
    fn process_exit(self) -> ! {
        let code = self.report();
        code.process_exit()
    }

    fn report(self) -> crate::Code {
        match self {
            Ok(()) => crate::Code::SUCCESS,
            Err(err) => {
                if let Some(msg) = err.msg {
                    // At this point, we might be exiting due to a broken pipe, just do our best and
                    // move on.
                    let _ = writeln!(std::io::stderr(), "{}", msg);
                }
                err.code
            }
        }
    }
}