Struct MmapTransportLayout 

pub struct MmapTransportLayout { /* private fields */ }

Stable file layout for one mmap-backed disruptor transport instance.

Implementations

impl MmapTransportLayout

pub fn new( root_dir: impl Into<PathBuf>, segment_name: impl Into<String>, ) -> MultiProcessResult<Self>

Create a new validated mmap transport layout rooted under root_dir.

pub fn ensure_directories(&self) -> MultiProcessResult<()>

Ensure the root and consumer directories exist.

pub fn ring_config( &self, buffer_size: usize, element_size: usize, create: bool, ) -> MmapFileConfig

Build the ring buffer config for this transport.

pub fn producer_cursor_config(&self, create: bool) -> MmapCursorConfig

Build the producer cursor config for this transport.

pub fn readiness_cursor_config(&self, create: bool) -> MmapCursorConfig

Build the readiness cursor config for this transport.

pub fn consumer_cursor_config( &self, consumer_id: &str, create: bool, ) -> MultiProcessResult<MmapCursorConfig>

Build a consumer cursor config for the given consumer id.

pub fn consumer_cursor_path( &self, consumer_id: &str, ) -> MultiProcessResult<PathBuf>

Return the consumer cursor path for a specific consumer id.

pub fn root_dir(&self) -> &Path

Return the layout root directory.

pub fn segment_name(&self) -> &str

Return the logical segment name for this layout.

pub fn ring_path(&self) -> &Path

Return the ring mapping path.

pub fn producer_cursor_path(&self) -> &Path

Return the producer cursor mapping path.

pub fn readiness_cursor_path(&self) -> &Path

Return the readiness cursor mapping path.

pub fn consumers_dir(&self) -> &Path

Return the directory holding per-consumer cursor files.

Trait Implementations

impl Clone for MmapTransportLayout

fn clone(&self) -> MmapTransportLayout

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MmapTransportLayout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MmapTransportLayout

fn eq(&self, other: &MmapTransportLayout) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MmapTransportLayout

impl StructuralPartialEq for MmapTransportLayout