Struct Stream 

pub struct Stream<T> {
    inner: Arc<StreamInner<T>>,
}

The producing end of a Stream: publishes every value to every reader.

Cloning shares the readers. A publish to a stream nobody reads is dropped, and the dead senders are pruned then. Publishing never blocks and never drops a value for a reader that is there: each reader’s queue is unbounded, so a reader that falls behind falls behind in memory.

Fields

inner: Arc<StreamInner<T>>

Implementations

impl<T> Stream<T>

where T: Clone,

pub fn new() -> Stream<T>

A stream nobody is subscribed to yet.

pub fn subscribe(&self) -> StreamReader<T>

A reader with its own queue, so one reader’s pace cannot starve another’s.

The queue is unbounded: a reader that stops pumping holds every value published since, and a publish never waits for it. A producer whose pace comes from outside the worlds it serves - a device, say - is the one to publish at a pace its readers keep up with.

pub fn publish(&self, value: T) -> usize

Publish one value to every reader, and answer how many are left.

A reader that dropped its queue is pruned here, so the producing world learns that nobody is left the next time it publishes.

pub fn publish_all(&self, values: impl IntoIterator<Item = T>) -> usize

Publish several values, in the order given.

pub fn has_readers(&self) -> bool

Whether a reader is subscribed, pruning the ones that went away.

Trait Implementations

impl<T> Clone for Stream<T>

where T: Clone,

fn clone(&self) -> Stream<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Stream<T>

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

Formats the value using the given formatter.

impl<T> Default for Stream<T>

where T: Clone,

fn default() -> Stream<T>

Returns the “default value” for a type.