Struct witx::InterfaceFunc

pub struct InterfaceFunc {
    pub abi: Abi,
    pub name: Id,
    pub params: Vec<InterfaceFuncParam>,
    pub results: Vec<InterfaceFuncParam>,
    pub noreturn: bool,
    pub docs: String,
}

Fields

abi: Abi

name: Id

params: Vec<InterfaceFuncParam>

results: Vec<InterfaceFuncParam>

noreturn: bool

docs: String

Implementations

impl InterfaceFunc

pub fn wasm_signature(&self) -> (Vec<WasmType>, Vec<WasmType>)

Get the WebAssembly type signature for this interface function

The first entry returned is the list of parameters and the second entry is the list of results for the wasm function signature.

pub fn call_wasm(&self, module: &Id, bindgen: &mut impl Bindgen)

Generates an abstract sequence of instructions which represents this function being adapted as an imported function.

The instructions here, when executed, will emulate a language with interface types calling the concrete wasm implementation. The parameters for the returned instruction sequence are the language’s own interface-types parameters. One instruction in the instruction stream will be a Call which represents calling the actual raw wasm function signature.

This function is useful, for example, if you’re building a language generator for WASI bindings. This will document how to translate language-specific values into the wasm types to call a WASI function, and it will also automatically convert the results of the WASI function back to a language-specific value.

pub fn call_interface(&self, module: &Id, bindgen: &mut impl Bindgen)

This is the dual of InterfaceFunc::call_wasm, except that instead of calling a wasm signature it generates code to come from a wasm signature and call an interface types signature.

impl InterfaceFunc

pub fn to_sexpr(&self) -> SExpr

Trait Implementations

impl Clone for InterfaceFunc

fn clone(&self) -> InterfaceFunc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InterfaceFunc

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

Formats the value using the given formatter.

impl Hash for InterfaceFunc

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<InterfaceFunc> for InterfaceFunc

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

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

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

This method tests for !=.

impl Eq for InterfaceFunc

impl StructuralEq for InterfaceFunc

impl StructuralPartialEq for InterfaceFunc