Skip to main content

ChannelReceiver

Struct ChannelReceiver 

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

Receiver for channel events.

Implementations§

Source§

impl ChannelReceiver

Source

pub fn ack_mode(&self) -> AckMode

Get the current ack mode for this receiver.

Source

pub fn current_offset(&self) -> u64

Get the next offset that will be assigned (i.e., total messages received so far).

Source

pub async fn recv(&mut self) -> Result<Event, ChannelError>

Receive the next event.

When AckMode::Auto, messages are automatically acknowledged on receive. When AckMode::Manual, messages are tracked as unacknowledged and must be explicitly acknowledged via [ack]. When AckMode::None, no tracking is performed.

Source

pub fn try_recv(&mut self) -> Result<Option<Event>, ChannelError>

Try to receive an event without blocking.

Source

pub fn ack(&self, offset: u64) -> Result<(), ChannelError>

Acknowledge a message by its offset.

Only meaningful when AckMode::Manual. Removes the message from the unacknowledged set. Returns an error if the offset is not found.

Source

pub fn unacked_count(&self) -> usize

Get the number of unacknowledged messages.

Source

pub fn acked_count(&self) -> usize

Get the number of acknowledged messages.

Source

pub fn get_unacked_messages(&self) -> Vec<(u64, Event)>

Get all unacknowledged messages for re-delivery.

Returns a vector of (offset, event) pairs for messages that have been received but not yet acknowledged.

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.