wasmtime::Config Class Reference

Configuration for Wasmtime. More...

#include <wasmtime.hh>

Public Member Functions
	Config ()
	Creates configuration with all the default settings.
void	debug_info (bool enable)
	Configures whether dwarf debuginfo is emitted for assisting in-process debugging. More...
void	epoch_interruption (bool enable)
	Configures whether epochs are enabled which can be used to interrupt currently executing WebAssembly. More...
void	consume_fuel (bool enable)
	Configures whether WebAssembly code will consume fuel and trap when it runs out. More...
void	max_wasm_stack (size_t stack)
	Configures the maximum amount of native stack wasm can consume. More...
void	wasm_threads (bool enable)
	Configures whether the WebAssembly threads proposal is enabled. More...
void	wasm_reference_types (bool enable)
	Configures whether the WebAssembly reference types proposal is enabled. More...
void	wasm_simd (bool enable)
	Configures whether the WebAssembly simd proposal is enabled. More...
void	wasm_bulk_memory (bool enable)
	Configures whether the WebAssembly bulk memory proposal is enabled. More...
void	wasm_multi_value (bool enable)
	Configures whether the WebAssembly multi value proposal is enabled. More...
void	wasm_gc (bool enable)
	Configures whether the WebAssembly Garbage Collection proposal will be enabled. More...
void	wasm_function_references (bool enable)
	Configures whether the WebAssembly function references proposal will be enabled. More...
void	parallel_compilation (bool enable)
	Configure whether wasmtime should compile a module using multiple threads. More...
void	strategy (Strategy strategy)
	Configures compilation strategy for wasm code. More...
void	cranelift_debug_verifier (bool enable)
	Configures whether cranelift's debug verifier is enabled. More...
void	cranelift_opt_level (OptLevel level)
	Configures cranelift's optimization level. More...
void	profiler (ProfilingStrategy profiler)
	Configures an active wasm profiler. More...
void	memory_reservation (size_t size)
	Configures the size of the initial linear memory allocation. More...
void	memory_guard_size (size_t size)
	Configures the size of memory's guard region. More...
Result< std::monostate >	cache_load_default ()
	Loads the default cache configuration present on the system. More...
Result< std::monostate >	cache_load (const std::string &path)
	Loads cache configuration from the specified filename. More...
void	pooling_allocation_strategy (const PoolAllocationConfig &config)
	Enables and configures the pooling allocation strategy. More...

Detailed Description

Configuration for Wasmtime.

This class is used to configure Wasmtime's compilation and various other settings such as enabled WebAssembly proposals.

For more information be sure to consult the rust documentation.

Examples

interrupt.cc.

Member Function Documentation

cache_load()

Result< std::monostate > wasmtime::Config::cache_load ( const std::string &  path )

inline

Loads cache configuration from the specified filename.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.cache_config_load

cache_load_default()

Result< std::monostate > wasmtime::Config::cache_load_default ( )

inline

Loads the default cache configuration present on the system.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.cache_config_load_default

consume_fuel()

void wasmtime::Config::consume_fuel ( bool  enable )

inline

Configures whether WebAssembly code will consume fuel and trap when it runs out.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.consume_fuel

cranelift_debug_verifier()

void wasmtime::Config::cranelift_debug_verifier ( bool  enable )

inline

Configures whether cranelift's debug verifier is enabled.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.cranelift_debug_verifier

cranelift_opt_level()

void wasmtime::Config::cranelift_opt_level ( OptLevel  level )

inline

Configures cranelift's optimization level.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.cranelift_opt_level

debug_info()

void wasmtime::Config::debug_info ( bool  enable )

inline

Configures whether dwarf debuginfo is emitted for assisting in-process debugging.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.debug_info

epoch_interruption()

void wasmtime::Config::epoch_interruption ( bool  enable )

inline

Configures whether epochs are enabled which can be used to interrupt currently executing WebAssembly.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.epoch_interruption

Examples

interrupt.cc.

max_wasm_stack()

void wasmtime::Config::max_wasm_stack ( size_t  stack )

inline

Configures the maximum amount of native stack wasm can consume.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.max_wasm_stack

memory_guard_size()

void wasmtime::Config::memory_guard_size ( size_t  size )

inline

Configures the size of memory's guard region.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.memory_guard_size

memory_reservation()

void wasmtime::Config::memory_reservation ( size_t  size )

inline

Configures the size of the initial linear memory allocation.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.memory_reservation

parallel_compilation()

void wasmtime::Config::parallel_compilation ( bool  enable )

inline

Configure whether wasmtime should compile a module using multiple threads.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.parallel_compilation

pooling_allocation_strategy()

void wasmtime::Config::pooling_allocation_strategy ( const PoolAllocationConfig &  config )

inline

Enables and configures the pooling allocation strategy.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.allocation_strategy

profiler()

void wasmtime::Config::profiler ( ProfilingStrategy  profiler )

inline

Configures an active wasm profiler.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.profiler

strategy()

void wasmtime::Config::strategy ( Strategy  strategy )

inline

Configures compilation strategy for wasm code.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.strategy

wasm_bulk_memory()

void wasmtime::Config::wasm_bulk_memory ( bool  enable )

inline

Configures whether the WebAssembly bulk memory proposal is enabled.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.wasm_bulk_memory

wasm_function_references()

void wasmtime::Config::wasm_function_references ( bool  enable )

inline

Configures whether the WebAssembly function references proposal will be enabled.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.wasm_function_references

wasm_gc()

void wasmtime::Config::wasm_gc ( bool  enable )

inline

Configures whether the WebAssembly Garbage Collection proposal will be enabled.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.wasm_gc

wasm_multi_value()

void wasmtime::Config::wasm_multi_value ( bool  enable )

inline

Configures whether the WebAssembly multi value proposal is enabled.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.wasm_multi_value

wasm_reference_types()

void wasmtime::Config::wasm_reference_types ( bool  enable )

inline

Configures whether the WebAssembly reference types proposal is enabled.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.wasm_reference_types

wasm_simd()

void wasmtime::Config::wasm_simd ( bool  enable )

inline

Configures whether the WebAssembly simd proposal is enabled.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.wasm_simd

wasm_threads()

void wasmtime::Config::wasm_threads ( bool  enable )

inline

Configures whether the WebAssembly threads proposal is enabled.

https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.wasm_threads

---

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

• include/wasmtime.hh