Struct MmapCursor 

pub struct MmapCursor { /* private fields */ }

File-backed mmap cursor with cache-line padding.

Implementations

impl MmapCursor

pub fn new( config: MmapCursorConfig, initial_value: i64, ) -> MultiProcessResult<Self>

Create or attach a file-backed mmap cursor.

pub fn attach(config: MmapCursorConfig) -> MultiProcessResult<Self>

Attach to an existing file-backed mmap cursor.

pub fn new_or_attach( config: MmapCursorConfig, initial_value: i64, ) -> MultiProcessResult<Self>

Create a new cursor if it does not exist, or attach to the existing one.

This is the mmap equivalent of SharedCursor::new_or_attach and is required for restart paths where a logical consumer must reattach to its existing sequence cursor instead of truncating it back to the initial value.

pub fn is_owner(&self) -> bool

Return whether this mapping created the backing file.

pub fn load(&self, ordering: Ordering) -> i64

Load the current value.

pub fn store(&self, value: i64, ordering: Ordering)

Store a new value.

pub fn compare_exchange( &self, current: i64, new: i64, success: Ordering, failure: Ordering, ) -> Result<i64, i64>

Compare and swap.

pub fn fetch_add(&self, value: i64, ordering: Ordering) -> i64

Fetch and add.

pub fn swap(&self, value: i64, ordering: Ordering) -> i64

Atomic swap.

pub fn path(&self) -> &Path

Return the backing path for this mmap cursor.

Trait Implementations

impl Clone for MmapCursor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for MmapCursor

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for MmapCursor

impl Sync for MmapCursor