Struct Stream 

pub struct Stream<T> {
    pub metrics: Arc<StreamMetrics>,
    /* private fields */
}

Bounded async stream with a declared backpressure policy. Clone-able handle — producer and consumer hold the same Arc.

Fields

metrics: Arc<StreamMetrics>

Implementations

impl<T: Send + 'static> Stream<T>

pub fn new(capacity: usize, annotation: BackpressureAnnotation) -> Self

Build a stream whose policy is DropOldest / PauseUpstream / Fail. Use Stream::with_degrader for DegradeQuality.

pub fn with_degrader( capacity: usize, annotation: BackpressureAnnotation, degrader: DegradationFn<T>, ) -> Self

Build a DegradeQuality stream with the mandatory degrader.

pub fn policy(&self) -> BackpressurePolicy

pub fn annotation(&self) -> &BackpressureAnnotation

pub async fn push(&self, item: T) -> Result<(), StreamError>

Push an item. Dispatches to the declared policy.

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

Pull the next item. Returns None when the stream is closed AND the buffer drained — analogous to a closed channel.

pub async fn close(&self)

Signal end-of-stream. Wakes pending consumers; idempotent.

pub async fn depth(&self) -> usize

Current buffer depth. Snapshot only — use for dashboards, never for flow-control (race with any concurrent push).

Trait Implementations

impl<T> Clone for Stream<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.