Struct StreamReader

pub struct StreamReader<B> { /* private fields */ }

Available on crate features runtime and component-model and component-model-async only.

Represents the readable end of a Component Model stream.

In order to pass this end to guest code, first convert it to a HostStream using the into method.

Implementations

impl<B> StreamReader<B>

pub fn is_closed(&self) -> bool

Returns whether this stream is “closed” meaning that the other end of the stream has been dropped.

pub async fn read(&mut self, accessor: impl AsAccessor, buffer: B) -> B

where B: Send + 'static,

Read values from this stream.

The returned Future will yield a (Some(_), _) if the read completed (possibly with zero items if the write was empty). It will return (None, _) if the read failed due to the closure of the write end. In either case, the returned buffer will be the same one passed as a parameter, with zero or more items added.

Panics

Panics if the store that the [Accessor] is derived from does not own this future.

pub async fn watch_writer(&mut self, accessor: impl AsAccessor)

where B: Send + 'static,

Wait until the write end of this stream is dropped.

Panics

Panics if the store that the [Accessor] is derived from does not own this future.

Trait Implementations

impl<B> Drop for StreamReader<B>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, B> From<StreamReader<B>> for HostStream<T>

fn from(value: StreamReader<B>) -> Self

Converts to this type from the input type.