kerb 0.1.1

Real-time telemetry from racing simulators — iRacing, AC Evo, Le Mans Ultimate
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

/// Errors returned by simulator backends and utility helpers.
#[derive(Debug)]
pub enum SimError {
    /// The simulator's shared memory region could not be opened (sim not running).
    NotConnected(String),
    /// No enabled simulator is currently running.
    NoSimRunning,
    /// The shared memory header contains unexpected or corrupt data.
    InvalidHeader(String),
    /// A standard I/O error (e.g. writing a snapshot file to disk).
    Io(std::io::Error),
}

/// Human-readable error messages for logging / display.
impl std::fmt::Display for SimError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            SimError::NotConnected(msg) => write!(f, "Not connected: {}", msg),
            SimError::NoSimRunning => write!(f, "No simulator is currently running"),
            SimError::InvalidHeader(msg) => write!(f, "Invalid header: {}", msg),
            SimError::Io(e) => write!(f, "IO error: {}", e),
        }
    }
}

impl std::error::Error for SimError {}

/// Allows `?` to convert [`std::io::Error`] into [`SimError::Io`] automatically.
impl From<std::io::Error> for SimError {
    fn from(e: std::io::Error) -> Self {
        SimError::Io(e)
    }
}