Struct FutureReader

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

Represents the readable end of a Component Model future.

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

Implementations

impl<T> FutureReader<T>

pub fn new<S>( instance: Instance, store: S, producer: impl FutureProducer<<S as AsContext>::Data, Item = T>, ) -> FutureReader<T>

where S: AsContextMut, T: Lower + Lift + Send + Sync + 'static,

Create a new future with the specified producer.

pub fn pipe<S>( self, store: S, consumer: impl FutureConsumer<<S as AsContext>::Data, Item = T> + Unpin, )

where S: AsContextMut, T: Lift + 'static,

Set the consumer that accepts the result of this future.

pub fn into_val(self) -> Val

Convert this FutureReader into a Val.

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

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

Attempt to convert the specified Val to a FutureReader.

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

Close this FutureReader, 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) -> GuardedFutureReader<T, A>

where A: AsAccessor,

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

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

Trait Implementations

impl<T> Debug for FutureReader<T>

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

Formats the value using the given formatter.

impl<T, A> From<GuardedFutureReader<T, A>> for FutureReader<T>

where A: AsAccessor,

fn from(guard: GuardedFutureReader<T, A>) -> FutureReader<T>

Converts to this type from the input type.

impl<T> ComponentType for FutureReader<T>

where T: Send + Sync,

impl<T> Lift for FutureReader<T>

where T: Send + Sync,

impl<T> Lower for FutureReader<T>

where T: Send + Sync,