Struct EventsChainRegion 

pub struct EventsChainRegion<const Q: usize> { /* private fields */ }

File-backed events-chain region (one slot pool + Q SPSC queues + Q MPSC queues of slot indices).

Implementations

impl<const Q: usize> EventsChainRegion<Q>

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

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

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

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

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

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

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

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

pub fn as_ptr(&self) -> *mut EventsChainLayout<Q>

Get the raw layout pointer for this mapping.

pub fn mapping_info(&self) -> MappingInfo

Return OS-facing metadata about the mapped backing region.

pub fn queue_spsc( &self, idx: usize, ) -> Result<(ChainSpscSender, ChainSpscReceiver), Error>

Split queue idx into (sender, receiver) handles.

This is a convenience wrapper around indexbus_core::split_chain_spsc.

pub fn queue_mpsc( &self, idx: usize, ) -> Result<(ChainMpscProducer, ChainMpscConsumer), Error>

Split MPSC queue idx into (producer, consumer) handles.

This is a convenience wrapper around indexbus_core::split_chain_mpsc.

Trait Implementations

impl<const Q: usize> Send for EventsChainRegion<Q>

impl<const Q: usize> Sync for EventsChainRegion<Q>