Struct CommonConfigOptions

Source

pub struct CommonConfigOptions { /* private fields */ }

Expand description

Defines the common configuration options.

CommonConfigOptions is used to set the common configuration options, which are

ImportExportMutGlobals supports mutable imported and exported globals.

Also see Import/Export Mutable Globals Proposal.
NonTrapFloatToIntConversions supports the non-trapping float-to-int conversion.

Also see Non-trapping Float-to-int Conversions Proposal.
SignExtensionOperators supports new integer instructions for sign-extending 8-bit, 16-bit, and 32-bit values.

Also see Sign-extension Operators Proposal.
MultiValue supports functions and instructions with multiple return values, and blocks with inputs.

Also see Multi-value Extension.
BulkMemoryOperations supports bulk memory operations.

Also see Bulk Memory Operations Proposal.
ReferenceTypes supports reference types.

Also see Reference Types Proposal.
SIMD supports 128-bit packed SIMD extension to WebAssembly.

Also see SIMD Proposal.
RelaxSIMD supports the relaxed SIMD instructions.

Also see Relaxed SIMD Proposal.
MultiMemories enables the use of multiple memories within a single Wasm module.

Also see Multiple Memories Proposal.
Threads supports the threading feature.

Also see Threading Proposal.
TailCall supports tail call optimization.

Also see Tail Call Proposal.
ExtendedConst supports extended constant expressions.

Also see Extended Const Expressions Proposal.
Annotations supports annotations in the WASM text format.

Also see Annotations Proposal.
Memory64 supports 64-bit memory indexes.

Also see Memory64 Proposal.
ExceptionHandling supports exception handling.

Also see Exception Handling Proposal.
FunctionReferences supports typed function references for WebAssembly.

Also see Function References Proposal.
GC supports garbage collection.

Also see GC Proposal.
Component supports the WebAssembly component model. The support is experimental.

Also see Component Model Proposal.

Implementations§

Source §

impl CommonConfigOptions

Source

pub fn new() -> Self

Creates a new instance of CommonConfigOptions.

The default options match the default proposal set of WasmEdge 0.17.1, which enables all the proposals of the WebAssembly 3.0 standard:

mutable_globals: true,
non_trap_conversions: true,
sign_extension_operators: true,
multi_value: true,
bulk_memory_operations: true,
reference_types: true,
simd: true,
relax_simd: true,
multi_memories: true,
threads: false,
gc: true,
tail_call: true,
extended_const: true,
annotations: false,
memory64: true,
exception_handling: true,
function_references: true,
component_model: false,
run_mode: RunMode::Interpreter,

Source

pub fn from_wasm_standard(standard: WasmStandard) -> Self

Creates a new instance of CommonConfigOptions with the proposal preset of the given WebAssembly standard.

The proposals that do not belong to the given standard, such as Annotations, Threads, and Component, are disabled.

§Argument

standard specifies the WebAssembly standard whose proposal preset is applied.

Source

pub fn mutable_globals(self, enable: bool) -> Self

Enables or disables the ImportExportMutGlobals option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn non_trap_conversions(self, enable: bool) -> Self

Enables or disables the NonTrapFloatToIntConversions option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn sign_extension_operators(self, enable: bool) -> Self

Enables or disables the SignExtensionOperators option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn multi_value(self, enable: bool) -> Self

Enables or disables the MultiValue option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn bulk_memory_operations(self, enable: bool) -> Self

Enables or disables the BulkMemoryOperations option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn reference_types(self, enable: bool) -> Self

Enables or disables the ReferenceTypes option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn simd(self, enable: bool) -> Self

Enables or disables the SIMD option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn relax_simd(self, enable: bool) -> Self

Enables or disables the RelaxSIMD option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn multi_memories(self, enable: bool) -> Self

Enables or disables the MultiMemories option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn threads(self, enable: bool) -> Self

Enables or disables the Threads option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn gc(self, enable: bool) -> Self

Enables or disables the GC option.

The GC proposal depends on the FunctionReferences and ReferenceTypes proposals: while GC is enabled, the runtime keeps both dependencies enabled and ignores disabling them.

§Argument

enable specifies if the option turns on or not.

Source

pub fn tail_call(self, enable: bool) -> Self

Enables or disables the TailCall option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn extended_const(self, enable: bool) -> Self

Enables or disables the ExtendedConst option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn annotations(self, enable: bool) -> Self

Enables or disables the Annotations option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn memory64(self, enable: bool) -> Self

Enables or disables the Memory64 option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn exception_handling(self, enable: bool) -> Self

Enables or disables the ExceptionHandling option.

§Argument

enable specifies if the option turns on or not.

Source

pub fn function_references(self, enable: bool) -> Self

Enables or disables the FunctionReferences option.

The FunctionReferences proposal depends on the ReferenceTypes proposal: while FunctionReferences is enabled, the runtime keeps ReferenceTypes enabled and ignores disabling it. Disabling FunctionReferences is ignored while the GC proposal stays enabled.

§Argument

enable - Whether the option turns on or not.

Source

pub fn component_model(self, enable: bool) -> Self

Enables or disables the Component option.

Notice that the WebAssembly component model support in WasmEdge is experimental.

§Argument

enable specifies if the option turns on or not.

Source

pub fn interpreter_mode(self, enable: bool) -> Self

👎Deprecated:

use run_mode instead; since WasmEdge 0.17.0, passing false is a no-op

Enables or disables the ForceInterpreter option.

§Argument

enable - Whether the option turns on or not.

Source

pub fn run_mode(self, mode: RunMode) -> Self

Sets the execution mode: interpreter, JIT, or AOT. By default, the mode is RunMode::Interpreter.

Since WasmEdge 0.17.0, only RunMode::Aot loads the AOT custom sections from a universal WASM file or dlopens a shared-library WASM artifact; in the other modes, the AOT data is ignored and the WASM runs in the selected engine.