proxit 1.0.1

UNIX-style error messages in Rust
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

//! For documentation on why this crate exists and how to use it, read the
//! [README][1] contained in the root of this crates git repository.
//!
//! [1]: https://git.thomasvoss.com/proxit/about

use std::{
	env,
	fmt::Display,
	process::{ExitCode, Termination},
};

/// A thin wrapper around a `Result` upon which the `Termination` trait is
/// implemented.  This is the type you’re going to want your `main()` function to
/// return.  The generic arguments provided to `MainResult` should match up with
/// those of the inner `Result` enum.
///
/// # Examples
///
/// ```
/// use proxit::MainResult;
///
/// fn main() -> MainResult<(), Error> {
/// 	work().into()
/// }
///
/// fn work() -> Result<(), Error> {
/// 	/* Your code here */
///
/// 	Ok(())
/// }
/// ```
pub struct MainResult<T, E>
where
	T: Termination,
	E: Display,
{
	underlying: Result<T, E>,
}

impl<T, E> Termination for MainResult<T, E>
where
	T: Termination,
	E: Display,
{
	fn report(self) -> ExitCode {
		match self.underlying {
			Ok(x) => x.report(),
			Err(e) => {
				let argv0 = env::args().next().unwrap_or("Error".into());
				eprint!("{argv0}: {e}");
				ExitCode::FAILURE
			}
		}
	}
}

impl<T, E> From<Result<T, E>> for MainResult<T, E>
where
	T: Termination,
	E: Display,
{
	fn from(value: Result<T, E>) -> Self {
		MainResult { underlying: value }
	}
}