Struct StoreContextMut 

pub struct StoreContextMut<'a, T: 'static>(/* private fields */);

A temporary handle to a &mut Store<T>.

This type is suitable for AsContextMut or AsContext trait bounds on methods if desired. For more information, see Store.

Implementations

impl<'a, T> StoreContextMut<'a, T>

pub async fn gc_async(&mut self, why: Option<&GcHeapOutOfMemory<()>>)

where T: Send + 'static,

Perform garbage collection of ExternRefs.

Same as Store::gc.

This method is only available when the gc Cargo feature is enabled.

pub fn epoch_deadline_async_yield_and_update(&mut self, delta: u64)

Configures epoch-deadline expiration to yield to the async caller and the update the deadline.

For more information see Store::epoch_deadline_async_yield_and_update.

impl<'a, T> StoreContextMut<'a, T>

pub fn data(&self) -> &T

Access the underlying data owned by this Store.

Same as Store::data.

pub fn data_mut(&mut self) -> &mut T

Access the underlying data owned by this Store.

Same as Store::data_mut.

pub fn engine(&self) -> &Engine

Returns the underlying Engine this store is connected to.

pub fn gc(&mut self, why: Option<&GcHeapOutOfMemory<()>>)

Perform garbage collection of ExternRefs.

Same as Store::gc.

This method is only available when the gc Cargo feature is enabled.

pub fn get_fuel(&self) -> Result<u64>

Returns remaining fuel in this store.

For more information see Store::get_fuel

pub fn set_fuel(&mut self, fuel: u64) -> Result<()>

Set the amount of fuel in this store.

For more information see Store::set_fuel

pub fn fuel_async_yield_interval(&mut self, interval: Option<u64>) -> Result<()>

Configures this Store to periodically yield while executing futures.

For more information see Store::fuel_async_yield_interval

pub fn set_epoch_deadline(&mut self, ticks_beyond_current: u64)

Sets the epoch deadline to a certain number of ticks in the future.

For more information see Store::set_epoch_deadline.

pub fn epoch_deadline_trap(&mut self)

Configures epoch-deadline expiration to trap.

For more information see Store::epoch_deadline_trap.

pub fn throw<R>( &mut self, exception: Rooted<ExnRef>, ) -> Result<R, ThrownException>

Set an exception as the currently pending exception, and return an error that propagates the throw.

See Store::throw for more details.

pub fn take_pending_exception(&mut self) -> Option<Rooted<ExnRef>>

Take the currently pending exception, if any, and return it, removing it from the “pending exception” slot.

See Store::take_pending_exception for more details.

pub fn has_pending_exception(&self) -> bool

Tests whether there is a pending exception.

See Store::has_pending_exception for more details.

Trait Implementations

impl<T: 'static> AsContext for StoreContextMut<'_, T>

type Data = T

The host information associated with the Store, aka the T in Store<T>.

fn as_context(&self) -> StoreContext<'_, T>

Returns the store context that this type provides access to.

impl<T: 'static> AsContextMut for StoreContextMut<'_, T>

fn as_context_mut(&mut self) -> StoreContextMut<'_, T>

Returns the store context that this type provides access to.

impl<'a, T: AsContextMut> From<&'a mut T> for StoreContextMut<'a, T::Data>

fn from(t: &'a mut T) -> StoreContextMut<'a, T::Data>

Converts to this type from the input type.

impl<'a, T: 'static> From<StoreContextMut<'a, T>> for StoreContext<'a, T>

fn from(store: StoreContextMut<'a, T>) -> StoreContext<'a, T>

Converts to this type from the input type.

impl<I, T> Index<I> for StoreContextMut<'_, T>

where StoreOpaque: Index<I>,

type Output = <StoreOpaque as Index<I>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<I, T> IndexMut<I> for StoreContextMut<'_, T>

where StoreOpaque: IndexMut<I>,

fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.