Struct soroban_wasmi::TypedFunc

pub struct TypedFunc<Params, Results> { /* private fields */ }

A typed Func instance.

Note

This allows a more efficient execution by avoiding type checks upon function call since those type checks are performed upon TypedFunc construction and enforced by the Rust type system.

Use TypedFunc instead of Func if possible.

Implementations

impl<Params, Results> TypedFunc<Params, Results>

pub fn func(&self) -> &Func

Returns the underlying Func.

Note

This loses the static type information in the process.

impl<Params, Results> TypedFunc<Params, Results>

where Params: WasmParams, Results: WasmResults,

pub fn call( &self, ctx: impl AsContextMut, params: Params ) -> Result<Results, Trap>

Calls this Wasm or host function with the specified parameters.

Returns either the results of the call, or a Trap if one happened.

For more information, see the Func::typed and Func::call documentation.

Panics

Panics if ctx does not own this TypedFunc.

Errors

If the execution of the called Wasm function traps.

pub fn call_resumable( &self, ctx: impl AsContextMut, params: Params ) -> Result<TypedResumableCall<Results>, Trap>

Calls this Wasm or host function with the specified parameters.

Returns a resumable handle to the function invocation upon enountering host errors with which it is possible to handle the error and continue the execution as if no error occured.

Note

This is a non-standard WebAssembly API and might not be available at other WebAssembly engines. Please be aware that depending on this feature might mean a lock-in to wasmi for users.

Errors

If the function returned a Trap originating from WebAssembly.

Trait Implementations

impl<Params, Results> Clone for TypedFunc<Params, Results>

fn clone(&self) -> TypedFunc<Params, Results>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Params, Results> Debug for TypedFunc<Params, Results>

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

Formats the value using the given formatter.

impl<Params, Results> Copy for TypedFunc<Params, Results>