zfi 0.2.0

Zero-cost and safe interface to UEFI firmware
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

use core::error::Error;
use core::fmt::{Display, Formatter};

/// Represents an `EFI_STATUS`.
#[repr(transparent)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[must_use]
pub struct Status(usize);

impl Status {
    pub const SUCCESS: Self = Self(0);
    pub const UNSUPPORTED: Self = Self::error(3);
    pub const BUFFER_TOO_SMALL: Self = Self::error(5);
    pub const ABORTED: Self = Self::error(21);

    #[cfg(target_pointer_width = "32")]
    const fn error(v: usize) -> Self {
        Self(0x80000000 | v)
    }

    #[cfg(target_pointer_width = "64")]
    const fn error(v: usize) -> Self {
        Self(0x8000000000000000 | v)
    }

    pub fn err_or<T>(self, success: T) -> Result<T, Self> {
        if self == Self::SUCCESS {
            Ok(success)
        } else {
            Err(self)
        }
    }

    pub fn is_success(self) -> bool {
        self == Self::SUCCESS
    }
}

impl Error for Status {}

impl Display for Status {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        match *self {
            Self::SUCCESS => f.write_str("the operation completed successfully"),
            Self::UNSUPPORTED => f.write_str("the operation is not supported"),
            Self::BUFFER_TOO_SMALL => f.write_str("the buffer is not large enough"),
            Self::ABORTED => f.write_str("the operation was aborted"),
            v => write!(f, "{:#x}", v.0),
        }
    }
}