Struct StreamWriter

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

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

Represents the writable end of a Component Model stream.

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

Implementations

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

where T: Lower + 'static, B: WriteBuffer<T>,

Write the specified items to the stream.

Note that this will only write as many items as the reader accepts during its current or next read. Use write_all to loop until the buffer is drained or the read end is dropped.

The returned Future will yield the input buffer back, possibly consuming a subset of the items or nothing depending on the number of items the reader accepted.

The is_closed method can be used to determine whether the stream was learned to be closed after this operation completes.

Panics

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

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

where T: Lower + 'static, B: WriteBuffer<T>,

Write the specified values until either the buffer is drained or the read end is dropped.

The buffer is returned back to the caller and may still contain items within it if the other end of this stream was dropped. Use the is_closed method to determine if the other end is dropped.

Panics

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

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

Wait for the read end of this stream to be dropped.

Panics

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

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

Close this StreamWriter, 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) -> GuardedStreamWriter<T, A>

where A: AsAccessor,

Returns a GuardedStreamWriter 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 GuardedStreamWriter return value.

Trait Implementations

impl<T, A> From<GuardedStreamWriter<T, A>> for StreamWriter<T>

where A: AsAccessor,

fn from(guard: GuardedStreamWriter<T, A>) -> Self

Converts to this type from the input type.