Struct BoundedAsyncStream 

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

A bounded, lossy-by-default, executor-agnostic async stream.

Items are pushed by one or more AsyncStreamSender handles and pulled asynchronously via BoundedAsyncStream::next.

See the module-level docs for the full design rationale.

Implementations

impl<T> BoundedAsyncStream<T>

pub fn new(capacity: usize) -> (Self, AsyncStreamSender<T>)

Creates a new bounded stream with the given capacity.

Returns the consumer side and a single producer; clone the sender to fan out to multiple producers.

Panics

Panics if capacity is 0 — a zero-capacity buffer would drop every item before the consumer could observe it. Use capacity 1 if you genuinely want “latest only” semantics.

pub const fn next(&self) -> NextItem<'_, T>

Returns a future that resolves to the next item, or None once the stream is closed and drained.

pub fn try_next(&self) -> Option<T>

Non-blocking pop. Returns None if the buffer is empty (regardless of whether the stream is open or closed).

pub fn is_closed(&self) -> bool

Returns true if the stream has been closed (all senders dropped). Note: a closed stream may still have buffered items to drain.

pub fn buffered_count(&self) -> usize

Returns the number of items currently buffered (0..=capacity).

pub fn capacity(&self) -> usize

Returns the buffer capacity, as passed to Self::new.

pub fn clear_buffer(&self)

Drops all currently buffered items without closing the stream.

Trait Implementations

impl<T> Debug for BoundedAsyncStream<T>

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

Formats the value using the given formatter.

impl<T> Drop for BoundedAsyncStream<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: 'static> Stream for BoundedAsyncStream<T>

Available on crate feature futures-stream only.

type Item = T

Values yielded by the stream.

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

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.