Struct StreamReader

pub struct StreamReader<T>
where
    T: 'static,
{ /* private fields */ }

Represents the readable end of a Component Model stream.

Implementations

impl<T> StreamReader<T>

pub fn read(&mut self, buf: Vec<T>) -> StreamRead<'_, T>

Starts a new read operation on this stream into buf.

This method will read values into the spare capacity of the buf provided. If buf has no spare capacity then this will be equivalent to a zero-length read.

Upon completion the buf will be yielded back to the caller via the completion of the StreamRead future.

Cancellation

Cancelling the returned future can be done with drop like all Rust futures, but it does not mean that no values were read. To accurately determine if values were read the StreamRead::cancel method must be used.

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

Reads a single item from this stream.

This is a higher-level method than StreamReader::read in that it reads only a single item and does not expose control over cancellation.

pub async fn collect(self) -> Vec<T>

Reads all items from this stream and returns the list.

This method will read all remaining items from this stream into a list and await the stream to be dropped.

Trait Implementations

impl<T> Debug for StreamReader<T>

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

Formats the value using the given formatter.

impl<T> Drop for StreamReader<T>

fn drop(&mut self)

Executes the destructor for this type.