Struct StreamReader 

pub struct StreamReader<T> {
    inner: Arc<ReaderInner<T>>,
}

The reading end of a Stream: one queue per reader, folded into the reader’s tick.

A reader is cheap to clone within the world that owns it; every clone shares the same queue and batch, so the world’s components read one tick’s events between them.

Fields

inner: Arc<ReaderInner<T>>

Implementations

impl<T> StreamReader<T>

pub fn pump(&self)

Start the reader’s tick: whatever queued since the last pump becomes the batch, and the previous batch is dropped.

Call it once per tick, before anything reads the batch. Calling it twice in one tick drops what the first call collected.

pub fn with_batch<R>(&self, f: impl FnOnce(&[T]) -> R) -> R

Run f over this tick’s values, oldest first.

Reading does not consume: every reader in the world sees the same batch, so no one can take a value away from the next. No lock is held while f runs, so f may read another stream, or this one again.

pub fn copy_into(&self, out: &mut Vec<T>)

where T: Clone,

Append this tick’s values, oldest first, to out.

Trait Implementations

impl<T> Clone for StreamReader<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for StreamReader<T>

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

Formats the value using the given formatter.