Struct soroban_wasmi::Linker

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

A linker used to define module imports and instantiate module instances.

Implementations

impl<T> Linker<T>

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

Creates a new linker.

pub fn engine(&self) -> &Engine

Returns the underlying Engine of the Linker.

pub fn define( &mut self, module: &str, name: &str, item: impl Into<Extern> ) -> Result<&mut Self, LinkerError>

Define a new item in this Linker.

Errors

If there already is a definition under the same name for this Linker.

pub fn func_new( &mut self, module: &str, name: &str, ty: FuncType, func: impl Fn(Caller<'_, T>, &[Value], &mut [Value]) -> Result<(), Trap> + Send + Sync + 'static ) -> Result<&mut Self, LinkerError>

Creates a new named Func::new-style host Func for this Linker.

For more information see Linker::func_wrap.

Errors

If there already is a definition under the same name for this Linker.

pub fn func_wrap<Params, Args>( &mut self, module: &str, name: &str, func: impl IntoFunc<T, Params, Args> ) -> Result<&mut Self, LinkerError>

Creates a new named Func::new-style host Func for this Linker.

For information how to use this API see Func::wrap.

This method creates a host function for this Linker under the given name. It is distint in its ability to create a Store independent host function. Host functions defined this way can be used to instantiate instances in multiple different Store entities.

The same applies to other Linker methods to define new Func instances such as Linker::func_new.

In a concurrently running program, this means that these host functions could be called concurrently if different Store entities are executing on different threads.

Errors

If there already is a definition under the same name for this Linker.

pub fn get( &self, context: impl AsContext<UserState = T>, module: &str, name: &str ) -> Option<Extern>

Looks up a defined Extern by name in this Linker.

• Returns None if this name was not previously defined in this Linker.
• Returns None if the definition is a Linker defined host function.

Panics

If the Engine of this Linker and the Engine of context are not the same.

pub fn instantiate( &self, context: impl AsContextMut<UserState = T>, module: &Module ) -> Result<InstancePre, Error>

Instantiates the given Module using the definitions in the Linker.

Panics

If the Engine of the Linker and context are not the same.

Errors

• If the linker does not define imports of the instantiated Module.
• If any imported item does not satisfy its type requirements.

Trait Implementations

impl<T> Clone for Linker<T>

fn clone(&self) -> Linker<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Linker<T>

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

Formats the value using the given formatter.

impl<T> Default for Linker<T>

fn default() -> Self

Returns the “default value” for a type.