wasmtime::Module Class Reference

Representation of a compiled WebAssembly module. More...

#include <wasmtime.hh>

Public Member Functions
	Module (const Module &other)
	Copies another module into this one.
Module &	operator= (const Module &other)
	Copies another module into this one.
	Module (Module &&other)=default
	Moves resources from another module into this one.
Module &	operator= (Module &&other)=default
	Moves resources from another module into this one.
ImportType::List	imports () const
	Returns the list of types imported by this module.
ExportType::List	exports () const
	Returns the list of types exported by this module.
Result< std::vector< uint8_t > >	serialize () const
	Serializes this module to a list of bytes. More...

Static Public Member Functions
static Result< Module >	compile (Engine &engine, std::string_view wat)
	Compiles a module from the WebAssembly text format. More...
static Result< Module >	compile (Engine &engine, Span< uint8_t > wasm)
	Compiles a module from the WebAssembly binary format. More...
static Result< std::monostate >	validate (Engine &engine, Span< uint8_t > wasm)
	Validates the provided WebAssembly binary without compiling it. More...
static Result< Module >	deserialize (Engine &engine, Span< uint8_t > wasm)
	Deserializes a previous list of bytes created with serialize. More...
static Result< Module >	deserialize_file (Engine &engine, const std::string &path)
	Deserializes a module from an on-disk file. More...

Detailed Description

Representation of a compiled WebAssembly module.

This type contains JIT code of a compiled WebAssembly module. A Module is connected to an Engine and can only be instantiated within that Engine. You can inspect a Module for its type information. This is passed as an argument to other APIs to instantiate it.

Examples

externref.cc, interrupt.cc, linking.cc, and memory.cc.

Member Function Documentation

compile() [1/2]

static Result< Module > wasmtime::Module::compile ( Engine &  engine, Span< uint8_t >  wasm  )

inlinestatic

Compiles a module from the WebAssembly binary format.

This function compiles the provided WebAssembly binary specified by wasm within the compilation settings configured by engine. This method is synchronous and will not return until the module has finished compiling.

This function can fail if the WebAssembly binary is invalid or doesn't validate (or similar).

compile() [2/2]

static Result< Module > wasmtime::Module::compile ( Engine &  engine, std::string_view  wat  )

inlinestatic

Compiles a module from the WebAssembly text format.

This function will automatically use wat2wasm on the input and then delegate to the compile function.

deserialize()

static Result< Module > wasmtime::Module::deserialize ( Engine &  engine, Span< uint8_t >  wasm  )

inlinestatic

Deserializes a previous list of bytes created with serialize.

This function is intended to be much faster than compile where it uses the artifacts of a previous compilation to quickly create an in-memory module ready for instantiation.

It is not safe to pass arbitrary input to this function, it is only safe to pass in output from previous calls to serialize. For more information see the Rust documentation - https://docs.wasmtime.dev/api/wasmtime/struct.Module.html#method.deserialize

deserialize_file()

static Result< Module > wasmtime::Module::deserialize_file ( Engine &  engine, const std::string &  path  )

inlinestatic

Deserializes a module from an on-disk file.

This function is the same as deserialize except that it reads the data for the serialized module from the path on disk. This can be faster than the alternative which may require copying the data around.

It is not safe to pass arbitrary input to this function, it is only safe to pass in output from previous calls to serialize. For more information see the Rust documentation - https://docs.wasmtime.dev/api/wasmtime/struct.Module.html#method.deserialize

serialize()

Result< std::vector< uint8_t > > wasmtime::Module::serialize ( ) const

inline

Serializes this module to a list of bytes.

The returned bytes can then be used to later pass to deserialize to quickly recreate this module in a different process perhaps.

validate()

static Result< std::monostate > wasmtime::Module::validate ( Engine &  engine, Span< uint8_t >  wasm  )

inlinestatic

Validates the provided WebAssembly binary without compiling it.

This function will validate whether the provided binary is indeed valid within the compilation settings of the engine provided.

---

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

• include/wasmtime.hh