Wasmtime
component/types/func.h File Reference
#include <wasmtime/conf.h>
#include <wasm.h>
#include <wasmtime/component/types/val.h>

Go to the source code of this file.

Typedefs

typedef struct wasmtime_component_func_type_t wasmtime_component_func_type_t
 Opaque type representing a component function type.
 

Functions

WASM_API_EXTERN wasmtime_component_func_type_twasmtime_component_func_type_clone (const wasmtime_component_func_type_t *ty)
 Clones a component function type. More...
 
WASM_API_EXTERN void wasmtime_component_func_type_delete (wasmtime_component_func_type_t *ty)
 Deallocates a component instance type.
 
WASM_API_EXTERN bool wasmtime_component_func_type_async (const wasmtime_component_func_type_t *ty)
 Returns whether this is an async function.
 
WASM_API_EXTERN size_t wasmtime_component_func_type_param_count (const wasmtime_component_func_type_t *ty)
 Returns the number of parameters of a component function type.
 
WASM_API_EXTERN bool wasmtime_component_func_type_param_nth (const wasmtime_component_func_type_t *ty, size_t nth, const char **name_ret, size_t *name_len_ret, wasmtime_component_valtype_t *type_ret)
 Retrieves the nth parameter. More...
 
WASM_API_EXTERN bool wasmtime_component_func_type_result (const wasmtime_component_func_type_t *ty, wasmtime_component_valtype_t *type_ret)
 Returns the result, if any, of this component function type. More...
 

Function Documentation

◆ wasmtime_component_func_type_clone()

WASM_API_EXTERN wasmtime_component_func_type_t * wasmtime_component_func_type_clone ( const wasmtime_component_func_type_t ty)

Clones a component function type.

The pointer returned from this function must be deallocated with wasmtime_component_func_type_delete.

◆ wasmtime_component_func_type_param_nth()

WASM_API_EXTERN bool wasmtime_component_func_type_param_nth ( const wasmtime_component_func_type_t ty,
size_t  nth,
const char **  name_ret,
size_t *  name_len_ret,
wasmtime_component_valtype_t type_ret 
)

Retrieves the nth parameter.

The type_ret return value must be deallocated with wasmtime_component_valtype_delete.

◆ wasmtime_component_func_type_result()

WASM_API_EXTERN bool wasmtime_component_func_type_result ( const wasmtime_component_func_type_t ty,
wasmtime_component_valtype_t type_ret 
)

Returns the result, if any, of this component function type.

The type_ret return value must be deallocated with wasmtime_component_valtype_delete.