Struct cargo::util::Queue

source ·
pub struct Queue<T> { /* private fields */ }
Expand description

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.

Implementations§

source§

impl<T> Queue<T>

source

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

Creates a queue with a given bound.

source

pub fn push(&self, item: T)

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

source

pub fn push_bounded(&self, item: T)

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

source

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

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

source

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

Pops all items from the queue without blocking.

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Queue<T>

§

impl<T> Send for Queue<T>where T: Send,

§

impl<T> Sync for Queue<T>where T: Send,

§

impl<T> Unpin for Queue<T>where T: Unpin,

§

impl<T> UnwindSafe for Queue<T>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.