Skip to main content

MpscQueue

Struct MpscQueue 

Source
pub struct MpscQueue<T> { /* private fields */ }
Expand description

Multi-producer single-consumer linked queue.

Cloneable handles are not provided; share via Arc<MpscQueue<T>>. Consumer methods (try_pop) require &mut self to encode single-consumer invariant at the type level.

Implementations§

Source§

impl<T> MpscQueue<T>

Source

pub fn new() -> Self

Source

pub fn push(&self, value: T)

Multi-producer push. Wait-free for the producer once the node is allocated.

Source

pub fn try_pop(&mut self) -> PopResult<T>

Consume one entry. Returns PopResult::Inconsistent if a producer is mid-publish; callers should retry.

Single consumer only: requires &mut self.

Trait Implementations§

Source§

impl<T> Default for MpscQueue<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T> Drop for MpscQueue<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl<T: Send> Send for MpscQueue<T>

Source§

impl<T: Send> Sync for MpscQueue<T>

Auto Trait Implementations§

§

impl<T> !Freeze for MpscQueue<T>

§

impl<T> !RefUnwindSafe for MpscQueue<T>

§

impl<T> Unpin for MpscQueue<T>

§

impl<T> UnsafeUnpin for MpscQueue<T>

§

impl<T> !UnwindSafe for MpscQueue<T>

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.