Struct soroban_wasmi::Instance

pub struct Instance(/* private fields */);

An instantiated WebAssembly Module.

This type represents an instantiation of a Module. It primarily allows to access its exports to call functions, get or set globals, read or write memory, etc.

When interacting with any Wasm code you will want to create an Instance in order to execute anything.

Instances are owned by a Store. Create new instances using Linker::instantiate.

Implementations

impl Instance

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

Returns the value exported to the given name if any.

Panics

Panics if store does not own this Instance.

pub fn get_func(&self, store: impl AsContext, name: &str) -> Option<Func>

Looks up an exported Func value by name.

Returns None if there was no export named name, or if there was but it wasn’t a function.

Panics

If store does not own this Instance.

pub fn get_typed_func<Params, Results>( &self, store: impl AsContext, name: &str ) -> Result<TypedFunc<Params, Results>, Error>

where Params: WasmParams, Results: WasmResults,

Looks up an exported Func value by name.

Returns None if there was no export named name, or if there was but it wasn’t a function.

Errors

• If there is no export named name.
• If there is no exported function named name.
• If Params or Results do not match the exported function type.

Panics

If store does not own this Instance.

pub fn get_global(&self, store: impl AsContext, name: &str) -> Option<Global>

Looks up an exported Global value by name.

Returns None if there was no export named name, or if there was but it wasn’t a global variable.

Panics

If store does not own this Instance.

pub fn get_table(&self, store: impl AsContext, name: &str) -> Option<Table>

Looks up an exported Table value by name.

Returns None if there was no export named name, or if there was but it wasn’t a table.

Panics

If store does not own this Instance.

pub fn get_memory(&self, store: impl AsContext, name: &str) -> Option<Memory>

Looks up an exported Memory value by name.

Returns None if there was no export named name, or if there was but it wasn’t a table.

Panics

If store does not own this Instance.

pub fn exports<'ctx, T: 'ctx>( &self, store: impl Into<StoreContext<'ctx, T>> ) -> ExportsIter<'ctx>

Returns an iterator over the exports of the Instance.

The order of the yielded exports is not specified.

Panics

Panics if store does not own this Instance.

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Instance

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

Formats the value using the given formatter.

impl PartialEq for Instance

fn eq(&self, other: &Instance) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Instance

impl Eq for Instance

impl StructuralEq for Instance

impl StructuralPartialEq for Instance