MpscConsumer

Struct MpscConsumer 

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

MPSC consumer handle for a SharedLayout events region.

Semantics (v1):

  • nonblocking receive (Ok(None) when empty)
  • try_recv_with borrows slot bytes only for the duration of the callback

Implementations§

Source§

impl MpscConsumer

Source

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

  • Ok(Some(len)) on success
  • Ok(None) if queue empty
  • Err(BufferTooSmall) if out is too small
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.

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

Source

pub fn try_recv_slot(&self) -> Result<Option<EventsSlot>, Error>

Receive a message as an owned slot handle.

The returned slot is valid until it is dropped (which frees it back to the pool) or forwarded via publish_slot.

Trait Implementations§

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.