Struct soroban_wasmi::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 fuel_consumed(&self) -> Option<u64>

Returns the amount of fuel consumed by executions of the Store so far.

Returns None if fuel metering is disabled.

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.