Skip to main content

AsyncQueue

Struct AsyncQueue 

Source
pub struct AsyncQueue<T> {
    queue: Mutex<VecDeque<T>>,
    capacity: usize,
    not_empty: CondVar,
    not_full: CondVar,
}
Expand description

Bounded async queue. Producers push (blocks while full), consumers recv (blocks while empty).

The mutex covers only the VecDeque push/pop, so slow work the consumer does after recv is never inside a lock.

§Example

use karyon_core::async_util::AsyncQueue;

async {
    let q = AsyncQueue::<u32>::new(8);
    q.push(1).await;
    let _ = q.recv().await;
};

Fields§

§queue: Mutex<VecDeque<T>>§capacity: usize§not_empty: CondVar§not_full: CondVar

Implementations§

Source§

impl<T> AsyncQueue<T>

Source

pub fn new(capacity: usize) -> Arc<Self>

Create an AsyncQueue with the given capacity. Panics if capacity is zero.

Source

pub async fn push(&self, item: T)

Push an item. Awaits while the queue is full.

Source

pub async fn recv(&self) -> T

Pop the next item. Awaits while the queue is empty.

Source

pub async fn len(&self) -> usize

Current number of items.

Source

pub async fn is_empty(&self) -> bool

True when the queue has no items.

Source

pub fn capacity(&self) -> usize

Configured capacity.

Auto Trait Implementations§

§

impl<T> !Freeze for AsyncQueue<T>

§

impl<T> !RefUnwindSafe for AsyncQueue<T>

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for AsyncQueue<T>

§

impl<T> UnwindSafe for AsyncQueue<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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 for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V