Struct nolock::queues::spsc::bounded::AsyncBoundedReceiver

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

An async variant of the BoundedReceiver that allows your to efficiently use this Queue in async Contexts as well.

Created using the async_queue method

Implementations

impl<T> AsyncBoundedReceiver<T>

pub fn is_closed(&self) -> bool

Checks if the Queue has been closed by the Producer

Note

Even when this indicates that the Queue is closed, there might still be Items left in the Queue that the Consumer should dequeue first to make sure that no data is lost

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

The async variant of the blocking dequeue operation on the Non-Async version of the Queue

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

Attempts to dequeue a single Item from the Queue.

This behaves just like the non-async try_dequeue operation

pub fn is_empty(&self) -> bool

Checks if the Queue is currently Empty

Trait Implementations

impl<T> Debug for AsyncBoundedReceiver<T>

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

Formats the value using the given formatter.