Skip to main content

CapacityPubSubSubscriber

Struct CapacityPubSubSubscriber 

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

Subscriber-side handle to a CapacityPubSubRing. Holds its own backing_idx + position within that backing and advances through the chain as it catches up.

Implementations§

Source§

impl CapacityPubSubSubscriber

Source

pub fn try_next(&mut self, out: &mut [u8]) -> Result<(), PubSubReadError>

Try to read the next payload. On Ok, the subscriber advances its position by 1. On Pending at a stale backing’s head, transparently advances to the next backing in the chain and retries; on Pending at the active backing’s head, returns Pending (no more data right now).

Source

pub fn backing_idx(&self) -> u64

Current backing chain index this subscriber is reading.

Source

pub fn position(&self) -> u64

Current position within the current backing.

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.