Struct nolock::queues::mpsc::jiffy::AsyncReceiver

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

This is the asynchronous Version of the Jiffy-Receiver

Implementations

impl<T> AsyncReceiver<T>

pub fn is_closed(&self) -> bool

Checks if the current Queue has been closed by the Producer

Note

This does not mean, that there are no more Elements in the Queue currently. It only indicates that there will be no new Elements inserted into the Queue, but there might still be a any number of Elements currently still left in the Queue.

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

This attempts to dequeue the first Element in the Queue.

This is the same as try_dequeue on the normal Jiffy-Queue

pub fn dequeue<'queue>(&'queue mut self) -> DequeueFuture<'queue, T>

This is the asynchronous version of the blocking dequeue operation on the normal Jiffy-Queue

Behaviour

The Future returned, will either resolve once an item is ready to be dequeued (Ok) or the Queue encountered a “fatal” error, like when the other side closes the Queue (Err)

Example

async fn demo() {
  let (mut rx, tx) = jiffy::async_queue::<usize>();

  tx.enqueue(13).unwrap();

  assert_eq!(Ok(13), rx.dequeue().await);
}

Trait Implementations

impl<T> Debug for AsyncReceiver<T>

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

Formats the value using the given formatter.