Struct Config

Source

pub struct Config { /* private fields */ }

Expand description

Configuration for an Engine.

Implementations§

Source §

impl Config

Source

pub fn set_max_recursion_depth(&mut self, value: usize) -> &mut Self

Sets the maximum recursion depth of the Engine’s stack during execution.

§Note

An execution traps if it exceeds this limits.

Source

pub fn set_min_stack_height(&mut self, value: usize) -> &mut Self

Sets the minimum (or initial) height of the Engine’s value stack in bytes.

§Note

Lower initial heights may improve memory consumption.
Higher initial heights may improve cold start times.

§Panics

If value is greater than the current maximum height of the value stack.

Source

pub fn set_max_stack_height(&mut self, value: usize) -> &mut Self

Sets the maximum height of the Engine’s value stack in bytes.

§Note

An execution traps if it exceeds this limits.

§Panics

If value is less than the current minimum height of the value stack.

Source

pub fn set_max_cached_stacks(&mut self, value: usize) -> &mut Self

Sets the maximum number of cached stacks for reuse for the Config.

§Note

A higher value may improve execution performance.
A lower value may improve memory consumption.

Source

pub fn wasm_mutable_global(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the mutable-global Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_sign_extension(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the sign-extension Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_saturating_float_to_int(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the saturating-float-to-int Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_multi_value(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the multi-value Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_multi_memory(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the multi-memory Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_bulk_memory(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the bulk-memory Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_reference_types(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the reference-types Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_tail_call(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the tail-call Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_extended_const(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the extended-const Wasm proposal for the Config.

§Note

Enabled by default.

Source

pub fn wasm_custom_page_sizes(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the custom-page-sizes Wasm proposal for the Config.

§Note

Disabled by default.

Source

pub fn wasm_memory64(&mut self, enable: bool) -> &mut Self

Available on crate features memory64 and validate only.

Enable or disable the memory64 Wasm proposal for the Config.

§Note

Enabled by default. (if memory64 crate feature is enabled)

Source

pub fn wasm_wide_arithmetic(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable the wide-arithmetic Wasm proposal for the Config.

Disabled by default.

Source

pub fn wasm_simd(&mut self, enable: bool) -> &mut Self

Available on crate features simd and validate only.

Enable or disable the simd Wasm proposal for the Config.

Enabled by default.

Source

pub fn wasm_relaxed_simd(&mut self, enable: bool) -> &mut Self

Available on crate features simd and validate only.

Enable or disable the relaxed-simd Wasm proposal for the Config.

Enabled by default.

Source

pub fn floats(&mut self, enable: bool) -> &mut Self

Available on crate feature validate only.

Enable or disable Wasm floating point (f32 and f64) instructions and types.

Enabled by default.

Source

pub fn consume_fuel(&mut self, enable: bool) -> &mut Self

Configures whether Wasmi will consume fuel during execution to either halt execution as desired.

§Note

This configuration can be used to make Wasmi instrument its internal bytecode so that it consumes fuel as it executes. Once an execution runs out of fuel a TrapCode::OutOfFuel trap is raised. This way users can deterministically halt or yield the execution of WebAssembly code.

Use Store::set_fuel to set the remaining fuel of the Store before executing some code as the Store start with no fuel.
Use Caller::set_fuel to update the remaining fuel when executing host functions.

Disabled by default.

Source

pub fn allow_start_fn(&mut self, allow: bool) -> &mut Self

Configures whether Wasmi allows Wasm modules with start functions.

Enabled by default.

Source

pub fn ignore_custom_sections(&mut self, enable: bool) -> &mut Self

Configures whether Wasmi will ignore custom sections when parsing Wasm modules.

Default value: false

Source

pub fn operator_cost(&mut self, cost: OperatorCost) -> &mut Self

Configures the fuel cost of each WebAssembly operator.

This is only relevant when Config::consume_fuel is enabled.

Source

pub fn fuel_cost(&mut self, cost: CustomFuelCosts) -> &mut Self

Configures the dynamic fuel cost.

This affects the following areas:

Lazy translation and validation of functions.
- For example if CompilationMode::Lazy or CompilationMode::LazyTranslation is used.
Copying bytes or values in the following Wasm operator executions:
- memory.{grow,copy,fill,init}
- table.{grow,copy,fill,init}

This is only relevant when Config::consume_fuel is enabled.

Source