Struct FanoutRegion 

pub struct FanoutRegion<const N: usize> { /* private fields */ }

File-backed shared fanout region.

See EventsRegion for the creator/joiner initialization model.

Implementations

impl<const N: usize> FanoutRegion<N>

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

Open (or create) a fanout region using the default path for name.

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

Open (or create) a fanout region using explicit options.

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

Open (or create) a fanout region backed by path.

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

Open (or create) a fanout region backed by path with explicit options.

See EventsRegion::open_path_with for error semantics.

pub fn as_ptr(&self) -> *mut SharedFanoutLayout<N>

Get the raw layout pointer for this mapping.

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

pub fn handles( &mut self, consumer: usize, ) -> Result<(FanoutProducer<N>, FanoutRouter<N>, FanoutConsumer<N>), Error>

Create producer/router/consumer handles for consumer.

Trait Implementations

impl<const N: usize> Send for FanoutRegion<N>

impl<const N: usize> Sync for FanoutRegion<N>