Struct Store

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

The store that owns all data associated to Wasm modules.

Implementations

impl<T> Store<T>

pub fn new(engine: &Engine, data: T) -> Self

Creates a new store.

pub fn engine(&self) -> &Engine

Returns the Engine that this store is associated with.

pub fn data(&self) -> &T

Returns a shared reference to the user provided data owned by this Store.

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

Returns an exclusive reference to the user provided data owned by this Store.

pub fn into_data(self) -> T

Consumes self and returns its user provided data.

pub fn limiter( &mut self, limiter: impl FnMut(&mut T) -> &mut dyn ResourceLimiter + Send + Sync + 'static, )

Installs a function into the Store that will be called with the user data type T to retrieve a ResourceLimiter any time a limited, growable resource such as a linear memory or table is grown.

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

Returns the remaining fuel of the Store if fuel metering is enabled.

Note

Enable fuel metering via Config::consume_fuel.

Errors

If fuel metering is disabled.

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

Sets the remaining fuel of the Store to value if fuel metering is enabled.

Note

Enable fuel metering via Config::consume_fuel.

Errors

If fuel metering is disabled.

pub fn call_hook( &mut self, hook: impl FnMut(&mut T, CallHook) -> Result<(), Error> + Send + Sync + 'static, )

Sets a callback function that is executed whenever a WebAssembly function is called from the host or a host function is called from WebAssembly, or these functions return.

The function is passed a &mut T to the underlying store, and a CallHook. CallHook can be used to find out what kind of function is being called or returned from.

The callback can either return Ok(()) or an Err with an Error. If an error is returned, it is returned to the host caller. If there are nested calls, only the most recent host caller receives the error and it is not propagated further automatically. The hook may be invoked again as new functions are called and returned from.

Trait Implementations

impl<T> AsContext for Store<T>

type Data = T

The user state associated with the Store, aka the T in Store<T>.

fn as_context(&self) -> StoreContext<'_, Self::Data>

Returns the store context that this type provides access to.

impl<T> AsContextMut for Store<T>

fn as_context_mut(&mut self) -> StoreContextMut<'_, Self::Data>

Returns the store context that this type provides access to.

impl<T: Debug> Debug for Store<T>

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

Formats the value using the given formatter.

impl<T> Default for Store<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.