microseh 1.1.2

Structured Exception Handling (SEH) for 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
66
67
68
69
70
71

use core::ffi::c_void;

use crate::{code::ExceptionCode, registers::Registers};

/// Represents an exception that occurs during program execution, along with additional
/// context information.
#[repr(C)]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Exception {
    code: ExceptionCode,
    address: *mut c_void,
    #[cfg(any(target_arch = "x86", target_arch = "x86_64", target_arch = "aarch64"))]
    registers: Registers,
}

impl Exception {
    /// Creates a new exception with default values.
    ///
    /// Exceptions created with this function are to be considered invalid, and should
    /// only be used as a placeholder.
    pub(crate) fn empty() -> Self {
        Self {
            code: ExceptionCode::Invalid,
            address: core::ptr::null_mut(),
            #[cfg(any(target_arch = "x86", target_arch = "x86_64", target_arch = "aarch64"))]
            registers: Registers::empty(),
        }
    }

    /// # Returns
    ///
    /// The system-specific code of the exception.
    pub fn code(&self) -> ExceptionCode {
        self.code
    }

    /// # Returns
    ///
    /// A pointer to the memory address where the exception occurred.
    pub fn address(&self) -> *mut c_void {
        self.address
    }

    /// # Returns
    ///
    /// The dump of the CPU registers at the time of the exception.
    #[cfg(any(target_arch = "x86", target_arch = "x86_64", target_arch = "aarch64"))]
    pub fn registers(&self) -> &Registers {
        &self.registers
    }
}

impl core::fmt::Display for Exception {
    /// Formats the exception into a human-readable string.
    ///
    /// # Arguments
    ///
    /// * `f` - The formatter to write to.
    ///
    /// # Returns
    ///
    /// Whether the formatting operation succeeded.
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}", self.code)
    }
}

/// In case the `std` feature is enabled, this implementation allows the exception to be
/// treated as a standard error.
#[cfg(feature = "std")]
impl std::error::Error for Exception {}