Struct StreamReader

Source
pub struct StreamReader<T> { /* private fields */ }
Available on crate features runtime and component-model and component-model-async only.
Expand description

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§

Source§

impl<T> StreamReader<T>

Source

pub fn is_closed(&self) -> bool

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

Source

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.

Source

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.

Source

pub fn into_val(self) -> Val

Convert this StreamReader into a Val.

Source

pub fn from_val( store: impl AsContextMut<Data: Send>, instance: Instance, value: &Val, ) -> Result<Self>

Attempt to convert the specified Val to a StreamReader.

Source

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.

Source

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

Convenience method around Self::close.

Source

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§

Source§

impl<T> Debug for StreamReader<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, A> From<GuardedStreamReader<T, A>> for StreamReader<T>
where A: AsAccessor,

Source§

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

Converts to this type from the input type.
Source§

impl<T: Send + Sync> ComponentType for StreamReader<T>

Source§

impl<T: Send + Sync> Lift for StreamReader<T>

Source§

impl<T: Send + Sync> Lower for StreamReader<T>

Auto Trait Implementations§

§

impl<T> Freeze for StreamReader<T>

§

impl<T> RefUnwindSafe for StreamReader<T>
where T: RefUnwindSafe,

§

impl<T> Send for StreamReader<T>
where T: Send,

§

impl<T> Sync for StreamReader<T>
where T: Sync,

§

impl<T> Unpin for StreamReader<T>
where T: Unpin,

§

impl<T> UnwindSafe for StreamReader<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.