Struct soroban_wasmi::Caller

pub struct Caller<'a, T> { /* private fields */ }

Represents the caller’s context when creating a host function via Func::wrap.

Implementations

impl<'a, T> Caller<'a, T>

pub fn new<C>(ctx: &'a mut C, instance: Option<&Instance>) -> Self

where C: AsContextMut<UserState = T>,

Creates a new Caller from the given store context and Instance handle.

pub fn get_export(&self, name: &str) -> Option<Extern>

Queries the caller for an exported definition identifier by name.

Returns None if there is no associated Instance of the caller or if the caller does not provide an export under the name name.

pub fn data(&self) -> &T

Returns a shared reference to the user provided host data.

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

Returns an exclusive reference to the user provided host data.

pub fn engine(&self) -> &Engine

Returns a shared reference to the used Engine.

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

Adds delta quantity of fuel to the remaining fuel.

Panics

If this overflows the remaining fuel counter.

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.

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

Returns the amount of total [Fuel] supplied to the Store.

Returns None if fuel metering is disabled.

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

Synthetically consumes an amount of fuel for the Store.

Returns the remaining amount of fuel after this operation.

Panics

If this overflows the consumed fuel counter.

Errors

• If fuel metering is disabled.
• If more fuel is consumed than available.

pub fn reset_fuel(&mut self) -> Result<(), FuelError>

Resets the total and consumed amounts of fuel to 0 for the Store.

Errors

• If fuel metering is disabled.

Trait Implementations

impl<T> AsContext for Caller<'_, T>

type UserState = T

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

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

Returns the store context that this type provides access to.

impl<T> AsContextMut for Caller<'_, T>

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

Returns the store context that this type provides access to.

impl<'a, T: AsContextMut> From<&'a mut T> for Caller<'a, T::UserState>

fn from(ctx: &'a mut T) -> Self

Converts to this type from the input type.