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

//! Module containing the error structures used in the crate.

use core::fmt;
#[cfg(feature = "std")]
use thiserror::Error;

/// Trait describing systems errors.
///
/// Most code in this crate is generic over the error type as long as it
/// implements this trait. The `create` method is used to create a new error
/// for the last OS error that occurred (on systems which work with an `errno`/
/// `GetLastError` etc. system).
pub trait SysErr: fmt::Debug + fmt::Display {
    /// Create error for the last OS error.
    fn create() -> Self;

    /// Create error from raw OS error code.
    fn from_code(code: i32) -> Self;
}

/// Trait describing (system) allocation errors.
///
/// Mostly meant as an extension trait to [`SysErr`] to allow for allocation
/// errors.
pub trait AllocErr: fmt::Debug + fmt::Display {
    fn alloc_err() -> Self;
}

/// System error containing no information.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "std", derive(Error))]
pub struct EmptySystemError;

impl fmt::Display for EmptySystemError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("system error")
    }
}

impl SysErr for EmptySystemError {
    fn create() -> Self {
        Self
    }

    fn from_code(_code: i32) -> Self {
        Self
    }
}

impl AllocErr for EmptySystemError {
    fn alloc_err() -> Self {
        Self
    }
}

/// System error containing the error code, as a [`std::io::Error`].
#[cfg(feature = "std")]
pub type StdSystemError = std::io::Error;

#[cfg(feature = "std")]
impl SysErr for StdSystemError {
    fn create() -> Self {
        Self::last_os_error()
    }

    fn from_code(code: i32) -> Self {
        Self::from_raw_os_error(code)
    }
}

#[cfg(feature = "std")]
impl AllocErr for StdSystemError {
    fn alloc_err() -> Self {
        std::io::ErrorKind::OutOfMemory.into()
    }
}

// Prefered error type in (internals) tests.
#[cfg(test)]
cfg_if::cfg_if!(
    if #[cfg(feature = "std")] {
        pub(crate) use StdSystemError as TestSysErr;
    } else {
        pub(crate) use EmptySystemError as TestSysErr;
    }
);