Struct soroban_wasmi::Func

#[repr(transparent)]
pub struct Func(_);

A Wasm or host function reference.

Implementations

impl Func

pub fn wrap<T, Params, Results>(
    ctx: impl AsContextMut<UserState = T>,
    func: impl IntoFunc<T, Params, Results>
) -> Self

Creates a new host function from the given closure.

pub fn func_type(&self, ctx: impl AsContext) -> FuncType

Returns the function type of the Func.

pub fn call<T>(
    &self,
    ctx: impl AsContextMut<UserState = T>,
    inputs: &[Value],
    outputs: &mut [Value]
) -> Result<(), Error>

Calls the Wasm or host function with the given inputs.

The result is written back into the outputs buffer.

Errors

• If the function returned a Trap.
• If the types of the inputs do not match the expected types for the function signature of self.
• If the number of input values does not match the expected number of inputs required by the function signature of self.
• If the number of output values does not match the expected number of outputs required by the function signature of self.

pub fn typed<Params, Results, S>(
    &self,
    ctx: S
) -> Result<TypedFunc<Params, Results>, Error>where
    Params: WasmParams,
    Results: WasmResults,
    S: AsContext,

Creates a new TypedFunc from this Func.

Note

This performs static type checks given Params as parameter types to Func and Results as result types of Func so that those type checks can be avoided when calling the created TypedFunc.

Trait Implementations

impl Clone for Func

fn clone(&self) -> Func

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Func

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

Formats the value using the given formatter.

impl From<Func> for Extern

fn from(func: Func) -> Self

Converts to this type from the input type.

impl Copy for Func