Struct Function

pub struct Function { /* private fields */ }

Defines a host function.

A WasmEdge Function defines a WebAssembly host function described by its type. A host function is a closure of the original function defined in either the host or the WebAssembly module.

Implementations

impl Function

pub unsafe fn create_sync_func<T>( ty: &FuncType, real_fn: SyncFn<T>, data: *mut T, cost: u64, ) -> WasmEdgeResult<Self>

Creates a host function with the given function type.

N.B. that this function is used for thread-safe scenarios.

Arguments

• ty - The types of the arguments and returns of the target function.

• real_fn - The pointer to the target function.

• data - The host context data used in this function.

• cost - The function cost in the Statistics. Pass 0 if the calculation is not needed.

Error

• If fail to create a Function, then WasmEdgeError::Func(FuncError::Create) is returned.

Safety

The lifetime of data must be greater than that of Function itself.

pub unsafe fn create_with_custom_wrapper( ty: &FuncType, fn_wrapper: CustomFnWrapper, real_fn: *mut c_void, data: *mut c_void, cost: u64, ) -> WasmEdgeResult<Self>

Creates a host function with the given function type and the custom function wrapper.

Arguments

• ty - The types of the arguments and returns of the target function.

• fn_wrapper - The custom function wrapper.

• real_fn - The pointer to the target function.

• data - The pointer to the host context data used in this function.

• cost - The function cost in the Statistics. Pass 0 if the calculation is not needed.

Error

• If fail to create a Function, then WasmEdgeError::Func(FuncError::Create) is returned.

Safety

Notice that the caller should guarantee the life cycle of both the real_fn and the data object.

pub unsafe fn as_ptr(&self) -> *mut WasmEdge_FunctionInstanceContext

Safety

The lifetime of the returned pointer must not exceed that of the object itself.

pub unsafe fn from_raw(ctx: *mut WasmEdge_FunctionInstanceContext) -> Self

Safety

This function will take over the lifetime management of ctx, so do not call ffi::WasmEdge_FunctionInstanceDelete on ctx after this.

Trait Implementations

impl AsFunc for Function

unsafe fn get_func_raw(&self) -> *mut WasmEdge_FunctionInstanceContext

Safety

fn ty(&self) -> Option<FuncType>

where Self: Sized,

impl AsMut<Function> for AsyncFunction

Available on crate feature async and Linux only.

fn as_mut(&mut self) -> &mut Function

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Function> for AsyncFunction

Available on crate feature async and Linux only.

fn as_ref(&self) -> &Function

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Function

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

Formats the value using the given formatter.

impl Drop for Function

fn drop(&mut self)

Executes the destructor for this type.