Struct nolock::queues::spsc::unbounded::UnboundedReceiver

pub struct UnboundedReceiver<T> { /* fields omitted */ }

The Receiver-Half of an unbounded Queue

Implementations

impl<T> UnboundedReceiver<T>

pub fn is_closed(&self) -> bool

Checks if the Queue has been closed by the Producer

Example

let (rx, tx) = unbounded::queue::<usize>();

// Dropping the Producer and therefore closing the Queue
drop(tx);

assert_eq!(true, rx.is_closed());

pub fn try_dequeue(&mut self) -> Result<T, DequeueError>

Attempts to dequeue a single Element from the Queue

Example

Successful Dequeue

let (mut rx, mut tx) = unbounded::queue::<usize>();

tx.enqueue(13).unwrap();

assert_eq!(Ok(13), rx.try_dequeue());

Dequeue on empty Queue

let (mut rx, mut tx) = unbounded::queue::<usize>();

assert_eq!(Err(DequeueError::WouldBlock), rx.try_dequeue());

pub fn dequeue(&mut self) -> Option<T>

A simple blocking dequeue operation. This is not lock-free anymore (obviously) and simply spins while trying to dequeue an element from the Queue until it succeeds

Trait Implementations

impl<T> Debug for UnboundedReceiver<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Drop for UnboundedReceiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for UnboundedReceiver<T>

impl<T> Sync for UnboundedReceiver<T>