Struct AsyncConsumer 

pub struct AsyncConsumer<T> { /* private fields */ }

Async receiving half. Implements Stream.

Implementations

impl<T> AsyncConsumer<T>

pub fn pop(&mut self) -> Option<T>

Pop one item from the prefetched window. Zero atomics. Call release after draining a batch.

pub fn release(&mut self)

Publish consumed position so the producer can reuse slots, and wake the producer if it is waiting for space.

pub fn prefetch(&mut self) -> usize

Load all items flushed since the last prefetch. One Acquire load.

pub fn prefetch_and_pop(&mut self) -> Option<T>

Prefetch + pop + release in one call.

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

Trait Implementations

impl<T> Debug for AsyncConsumer<T>

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

Formats the value using the given formatter.

impl<T> Drop for AsyncConsumer<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: Send> Send for AsyncConsumer<T>

impl<T> Stream for AsyncConsumer<T>

type Item = T

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.