Enum Queue

pub enum Queue<T> {
    Bounded {
        sender: Arc<Mutex<Option<Sender<T>>>>,
        receiver: Arc<Mutex<Option<Receiver<T>>>>,
        capacity: usize,
    },
    Unbounded {
        sender: Arc<Mutex<Option<UnboundedSender<T>>>>,
        receiver: Arc<Mutex<Option<UnboundedReceiver<T>>>>,
    },
}

A Queue represents a concurrent queue with a Stream interface for dequeuing and async methods for enqueuing.

Variants

Bounded

Fields

sender: Arc<Mutex<Option<Sender<T>>>>

receiver: Arc<Mutex<Option<Receiver<T>>>>

capacity: usize

Unbounded

Fields

sender: Arc<Mutex<Option<UnboundedSender<T>>>>

receiver: Arc<Mutex<Option<UnboundedReceiver<T>>>>

Implementations

impl<T> Queue<T>

where T: Send + 'static,

pub fn bounded(capacity: usize) -> Self

Create a new bounded queue with the given capacity

pub fn unbounded() -> Self

Create a new unbounded queue

pub async fn enqueue(&self, item: T) -> Result<(), QueueError>

Enqueue an item into the queue

pub async fn try_enqueue(&self, item: T) -> Result<(), QueueError>

Try to enqueue an item without blocking

pub fn dequeue(&self) -> impl Stream<Item = T> + Send + 'static

Get a rs2_stream for dequeuing items

pub async fn close(&self)

Close the queue, preventing further enqueues

pub fn capacity(&self) -> Option<usize>

Get the capacity of the queue (None for unbounded)

pub async fn is_empty(&self) -> bool

Check if the queue is empty

pub async fn len(&self) -> usize

Get the current number of items in the queue

Trait Implementations

impl<T: Clone> Clone for Queue<T>

fn clone(&self) -> Queue<T>

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Queue<T>

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

Formats the value using the given formatter.