Skip to main content

SubscriberPosition

Struct SubscriberPosition 

Source
pub struct SubscriberPosition { /* private fields */ }
Expand description

MMF-backed monotonically-increasing consumer position counter.

Implementations§

Source§

impl SubscriberPosition

Source

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

Create a new position counter at path initialised to initial.

Source

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

Open an existing position counter at path for read/write. Used by a subscriber restart path.

Source

pub fn get(&self) -> u64

Current position (Acquire load).

Source

pub fn advance(&self, by: u64) -> u64

Advance the position by by. Returns the NEW position. Atomic; safe for one subscriber to call concurrently with another holder reading via get.

Source

pub fn set(&self, new: u64)

Set the position to new unconditionally. Used by restart paths that want to reset rather than advance.

Source

pub fn compare_and_set(&self, expected: u64, new: u64) -> Result<u64, u64>

Compare-and-set semantics. Returns Ok(new) if the previous value matched expected; Err(actual) otherwise.

Source

pub fn counter_handle(&self) -> Arc<SharedAtomicU64>

Clone the underlying Arc<SharedAtomicU64> so a second in-process holder can read the same counter cheaply.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.