Struct ReadStream

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

ReadStream is the reading side of a stream.

From the ReadStream you can get windows into the current stream by calling read_buf().

Implementations

impl<T: Copy> ReadStream<T>

pub fn total_size(&self) -> usize

Return total length of underlying circular buffer (before the mapping doubling).

pub fn read_buf(&self) -> Result<(BufferReader<T>, Vec<Tag>)>

Return a BufferReader allowing you to read from the stream, and “consume” from it.

See WriteStream::write_buf for details about the refcount checks.

pub fn wait_for_read(&self, need: usize) -> bool

Return true if the needed number of samples will never arrive.

pub fn eof(&self) -> bool

Return true if there is nothing more ever to read from the stream.

Trait Implementations

impl<T: Debug> Debug for ReadStream<T>

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

Formats the value using the given formatter.

impl<T: Copy + Sync + Send + 'static> StreamWait for ReadStream<T>

fn id(&self) -> usize

ID shared between read and write side.

fn wait(&self, need: usize) -> bool

Wait for “a while” or until need samples are available/space available.

fn closed(&self) -> bool

Return true if the other end of this stream is disconnected.