Struct cargo::util::Queue

pub struct Queue<T> {
    state: Mutex<State<T>>,
    popper_cv: Condvar,
    bounded_cv: Condvar,
    bound: usize,
}

A simple, threadsafe, queue of items of type T

This is a sort of channel where any thread can push to a queue and any thread can pop from a queue.

This supports both bounded and unbounded operations. push will never block, and allows the queue to grow without bounds. push_bounded will block if the queue is over capacity, and will resume once there is enough capacity.

Fields

state: Mutex<State<T>>

popper_cv: Condvar

bounded_cv: Condvar

bound: usize

Implementations

impl<T> Queue<T>

pub fn new(bound: usize) -> Queue<T>

Creates a queue with a given bound.

pub fn push(&self, item: T)

Pushes an item onto the queue, regardless of the capacity of the queue.

pub fn push_bounded(&self, item: T)

Pushes an item onto the queue, blocking if the queue is full.

pub fn pop(&self, timeout: Duration) -> Option<T>

Pops an item from the queue, blocking if the queue is empty.

pub fn try_pop_all(&self) -> Vec<T>

Pops all items from the queue without blocking.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes