wasmtime::Linker Class Reference

Helper class for linking modules together with name-based resolution. More...

#include <linker.hh>

Public Member Functions
	Linker (Engine &engine)
	Creates a new linker which will instantiate in the given engine.
void	allow_shadowing (bool allow)
Result< std::monostate >	define (Store::Context cx, std::string_view module, std::string_view name, const Extern &item)
	Defines the provided item into this linker with the given name.
Result< std::monostate >	define_wasi ()
Result< std::monostate >	define_instance (Store::Context cx, std::string_view name, Instance instance)
TrapResult< Instance >	instantiate (Store::Context cx, const Module &m)
Result< std::monostate >	module (Store::Context cx, std::string_view name, const Module &m)
std::optional< Extern >	get (Store::Context cx, std::string_view module, std::string_view name)
template<typename F , std::enable_if_t< std::is_invocable_r_v< Result< std::monostate, Trap >, F, Caller, Span< const Val >, Span< Val > >, bool > = true>
Result< std::monostate >	func_new (std::string_view module, std::string_view name, const FuncType &ty, F &&f)
template<typename F , std::enable_if_t< WasmHostFunc< F >::Params::valid, bool > = true, std::enable_if_t< WasmHostFunc< F >::Results::valid, bool > = true>
Result< std::monostate >	func_wrap (std::string_view module, std::string_view name, F &&f)
Result< Func >	get_default (Store::Context cx, std::string_view name)
Result< std::monostate >	define_unknown_imports_as_traps (Module &module)
	Defines any import of module previously unknown to this linker as a trap.
Result< std::monostate >	define_unknown_imports_as_default_values (Store::Context cx, Module &module)
	Defines any import of module previously unknown to this linker as the "default" value for that import, for example a function that returns zeros.

Detailed Description

Helper class for linking modules together with name-based resolution.

This class is used for easily instantiating Modules by defining names into the linker and performing name-based resolution during instantiation. A Linker can also be used to link in WASI functions to instantiate a module.

Member Function Documentation

allow_shadowing()

void wasmtime::Linker::allow_shadowing ( bool  allow )

inline

Configures whether shadowing previous names is allowed or not.

By default shadowing is not allowed.

define_instance()

Result< std::monostate > wasmtime::Linker::define_instance ( Store::Context  cx, std::string_view  name, Instance  instance  )

inline

Defines all exports of the instance provided in this linker with the given module name of name.

define_wasi()

Result< std::monostate > wasmtime::Linker::define_wasi ( )

inline

Defines WASI functions within this linker.

Note that Store::Context::set_wasi must also be used for instantiated modules to have access to configured WASI state.

func_new()

template<typename F , std::enable_if_t< std::is_invocable_r_v< Result< std::monostate, Trap >, F, Caller, Span< const Val >, Span< Val > >, bool > = true>

Result< std::monostate > wasmtime::Linker::func_new ( std::string_view  module, std::string_view  name, const FuncType &  ty, F &&  f  )

inline

Defines a new function in this linker in the style of the Func constructor.

func_wrap()

template<typename F , std::enable_if_t< WasmHostFunc< F >::Params::valid, bool > = true, std::enable_if_t< WasmHostFunc< F >::Results::valid, bool > = true>

Result< std::monostate > wasmtime::Linker::func_wrap ( std::string_view  module, std::string_view  name, F &&  f  )

inline

Defines a new function in this linker in the style of the Func::wrap constructor.

get()

std::optional< Extern > wasmtime::Linker::get ( Store::Context  cx, std::string_view  module, std::string_view  name  )

inline

Attempts to load the specified named item from this linker, returning std::nullopt if it was not defined.

get_default()

Result< Func > wasmtime::Linker::get_default ( Store::Context  cx, std::string_view  name  )

inline

Loads the "default" function, according to WASI commands and reactors, of the module named name in this linker.

instantiate()

TrapResult< Instance > wasmtime::Linker::instantiate ( Store::Context  cx, const Module &  m  )

inline

Instantiates the module m provided within the store cx using the items defined within this linker.

module()

Result< std::monostate > wasmtime::Linker::module ( Store::Context  cx, std::string_view  name, const Module &  m  )

inline

Defines instantiations of the module m within this linker under the given name.

---

The documentation for this class was generated from the following file:

• linker.hh