Struct EventsRegion 

pub struct EventsRegion { /* private fields */ }

File-backed shared events region (SPSC + MPSC).

Creator/joiner behavior:

• If the backing file is new/empty, the first opener initializes the layout.
• If another process is initializing, openers wait until initialized == 2.
• Joiners validate the v1 header, claimed layout size, and requested capabilities.

Implementations

impl EventsRegion

pub fn open(name: &str) -> Result<Self, Error>

Open (or create) an events region using the default path for name.

pub fn open_with(name: &str, options: OpenOptions) -> Result<Self, Error>

Open (or create) an events region using explicit options.

pub fn open_path(path: impl AsRef<Path>) -> Result<Self, Error>

Open (or create) an events region backed by path.

pub fn open_path_with( path: impl AsRef<Path>, options: OpenOptions, ) -> Result<Self, Error>

Open (or create) an events region backed by path with explicit options.

Errors

Returns:

• Error::Io on filesystem/mapping failures
• Error::Misaligned if the mapping base address does not meet the ABI alignment
• Error::RegionTooSmall if the mapped file is smaller than the layout claims
• Error::Layout if the region is uninitialized or incompatible (wrong options/caps)

pub fn as_ptr(&self) -> *mut SharedLayout

Get the raw layout pointer for this mapping.

The pointer is valid as long as the EventsRegion is alive.

pub fn split_spsc(&mut self) -> Result<(SpscSender, SpscReceiver), Error>

Split the region into an SPSC sender/receiver pair.

This validates the mapping header before constructing the handles.

pub fn split_mpsc(&mut self) -> Result<(MpscProducer, MpscConsumer), Error>

Split the region into an MPSC producer/consumer pair.

This validates the mapping header before constructing the handles.

Trait Implementations

impl Send for EventsRegion

impl Sync for EventsRegion