Struct wasmtime::StoreContextMut

#[repr(transparent)]
pub struct StoreContextMut<'a, T>(_);

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

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

Implementations

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)

Perform garbage collection of ExternRefs.

Same as Store::gc.

pub fn fuel_consumed(&self) -> Option<u64>

Returns the fuel consumed by this store.

For more information see Store::fuel_consumed.

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

Inject more fuel into this store to be consumed when executing wasm code.

For more information see Store::add_fuel

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

Synthetically consume fuel from this store.

For more information see Store::consume_fuel

pub fn out_of_fuel_trap(&mut self)

Configures this Store to trap whenever fuel runs out.

For more information see Store::out_of_fuel_trap

pub fn out_of_fuel_async_yield(
    &mut self,
    injection_count: u64,
    fuel_to_inject: u64
)

Configures this Store to yield while executing futures whenever fuel runs out.

For more information see Store::out_of_fuel_async_yield

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 epoch_deadline_async_yield_and_update(&mut self, delta: u64)

Available on crate feature async only.

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.

Trait Implementations

impl<T> 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> 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<I, T> Index<I> for StoreContextMut<'_, T>where
    StoreData: Index<I>,

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

The returned type after indexing.

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

Performs the indexing (container[index]) operation.