FanoutConsumer

Struct FanoutConsumer 

Source
pub struct FanoutConsumer<const N: usize> { /* private fields */ }
Expand description

Consumer handle for a fanout events region.

Consumers only receive messages after they have been routed into their consumer queue. Without a running router, consumers will not observe new messages.

Implementations§

Source§

impl<const N: usize> FanoutConsumer<N>

Source

pub fn try_recv_into(&self, out: &mut [u8]) -> Result<Option<usize>, Error>

Attempt to receive the next message into out.

Returns:

  • Ok(Some(n)) when a message of length n was copied into out
  • Ok(None) when empty (or if consumer is out of range)
  • Err(Error::BufferTooSmall) when out cannot hold the message
Source

pub fn try_recv_with<F, R, E>( &self, f: F, ) -> Result<Option<R>, RecvWithError<E>>
where F: FnOnce(&[u8]) -> Result<R, E>,

Receive by borrowing the slot bytes for the duration of f.

The borrowed &[u8] is only valid for the duration of the callback.

If the callback returns Err, the message is still considered consumed; it will not be re-delivered.

Trait Implementations§

Source§

impl<const N: usize> Send for FanoutConsumer<N>

Auto Trait Implementations§

§

impl<const N: usize> Freeze for FanoutConsumer<N>

§

impl<const N: usize> !RefUnwindSafe for FanoutConsumer<N>

§

impl<const N: usize> !Sync for FanoutConsumer<N>

§

impl<const N: usize> Unpin for FanoutConsumer<N>

§

impl<const N: usize> !UnwindSafe for FanoutConsumer<N>

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.