Struct Queue 

pub struct Queue<A: Send + 'static> { /* private fields */ }

Cloneable multi-producer / multi-consumer queue with several backpressure modes.

Implementations

impl<A: Send + 'static> Queue<A>

pub fn bounded(capacity: usize) -> Effect<Queue<A>, (), ()>

Bounded queue: Queue::offer returns false when full (no blocking).

pub fn unbounded() -> Effect<Queue<A>, (), ()>

Unbounded queue.

pub fn dropping(capacity: usize) -> Effect<Queue<A>, (), ()>

Bounded queue that drops the incoming element when full.

pub fn sliding(capacity: usize) -> Effect<Queue<A>, (), ()>

Fixed-capacity queue that drops the oldest element when full.

pub fn offer(&self, value: A) -> Effect<bool, (), ()>

Try to enqueue one value. false means the value was not stored (full, dropping, or shut down).

pub fn offer_all<I>(&self, iter: I) -> Effect<Vec<A>, (), ()>

where I: IntoIterator<Item = A> + 'static, I::IntoIter: Send + 'static,

Enqueue as many values as possible; returns those that could not be stored (in order).

pub fn take(&self) -> Effect<A, QueueError, ()>

Block until a value is available or the queue disconnects.

pub fn take_all(&self) -> Effect<Chunk<A>, QueueError, ()>

Wait for at least one element, then drain all currently available elements.

pub fn take_up_to(&self, n: usize) -> Effect<Chunk<A>, QueueError, ()>

After the first element arrives, take at most n elements total (including the first).

pub fn take_n(&self, n: usize) -> Effect<Chunk<A>, QueueError, ()>

Block until n separate receives complete (or disconnect).

pub fn take_between( &self, min: usize, max: usize, ) -> Effect<Chunk<A>, QueueError, ()>

Take between min and max elements inclusive (waits for min values unless disconnected).

pub fn poll(&self) -> Effect<Option<A>, QueueError, ()>

Non-blocking receive.

pub fn size(&self) -> Effect<usize, (), ()>

Queued element count (approximate for flume).

pub fn is_empty(&self) -> Effect<bool, (), ()>

true when there are no queued elements.

pub fn is_full(&self) -> Effect<bool, (), ()>

true when at capacity (bounded / sliding) or shut down (flume side).

pub fn shutdown(&self) -> Effect<(), (), ()>

Close the queue to producers; buffered values remain available to receivers.

pub fn is_shutdown(&self) -> Effect<bool, (), ()>

true after Self::shutdown has completed.

pub fn await_shutdown(&self) -> Effect<(), (), ()>

Completes after Self::shutdown has been observed.

Trait Implementations

impl<A: Send + 'static> Clone for Queue<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.