ipc_ring 0.2.1

High-performance memory-mapped SPSC ring buffer for Unix IPC
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

//! Manual-reset event abstraction used by the ring.

#[cfg(target_os = "linux")]
mod linux;
#[cfg(target_os = "linux")]
pub use linux::ManualResetEvent;

#[cfg(not(target_os = "linux"))]
mod fallback;
#[cfg(not(target_os = "linux"))]
pub use fallback::ManualResetEvent;

use std::error::Error;
use std::fmt;

#[derive(Debug)]
pub enum EventError {
    Timeout,
    #[cfg_attr(not(target_os = "linux"), allow(dead_code))]
    Io(std::io::Error),
}

impl fmt::Display for EventError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Timeout => write!(f, "wait timed out"),
            Self::Io(err) => write!(f, "event error: {err}"),
        }
    }
}

impl Error for EventError {}