Struct StreamReader

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

Represents the readable end of a Component Model stream.

Note that StreamReader instances must be disposed of using close; otherwise the in-store representation will leak and the writer end will hang indefinitely. Consider using GuardedStreamReader to ensure that disposal happens automatically.

Implementations

impl<T> StreamReader<T>

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<B>(&mut self, accessor: impl AsAccessor, buffer: B) -> B

where T: Lift + 'static, B: ReadBuffer<T> + 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)

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.

pub fn into_val(self) -> Val

Convert this StreamReader into a Val.

pub fn from_val( store: impl AsContextMut, instance: Instance, value: &Val, ) -> Result<StreamReader<T>, Error>

where <impl AsContextMut as AsContext>::Data: Send,

Attempt to convert the specified Val to a StreamReader.

pub fn close(&mut self, store: impl AsContextMut)

Close this StreamReader, writing the default value.

Panics

Panics if the store that the [Accessor] is derived from does not own this future. Usage of this future after calling close will also cause a panic.

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

Convenience method around Self::close.

pub fn guard<A>(self, accessor: A) -> GuardedStreamReader<T, A>

where A: AsAccessor,

Returns a GuardedStreamReader which will auto-close this stream on drop and clean it up from the store.

Note that the accessor provided must own this future and is additionally transferred to the GuardedStreamReader return value.

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, A> From<GuardedStreamReader<T, A>> for StreamReader<T>

where A: AsAccessor,

fn from(guard: GuardedStreamReader<T, A>) -> StreamReader<T>

Converts to this type from the input type.

impl<T> ComponentType for StreamReader<T>

where T: Send + Sync,

impl<T> Lift for StreamReader<T>

where T: Send + Sync,

impl<T> Lower for StreamReader<T>

where T: Send + Sync,