wasmtime::Store::Context Class Reference

An interior pointer into a Store. More...

#include <wasmtime.hh>

Public Member Functions
	Context (Store &store)
	Creates a context referencing the provided Store.
	Context (Store *store)
	Creates a context referencing the provided Store.
	Context (Caller &caller)
	Creates a context referencing the provided Caller.
	Context (Caller *caller)
	Creates a context referencing the provided Caller.
void	gc ()
Result< std::monostate >	set_fuel (uint64_t fuel)
Result< uint64_t >	get_fuel () const
void	set_data (std::any data) const
	Set user specified data associated with this store.
std::any &	get_data () const
	Get user specified data associated with this store.
Result< std::monostate >	set_wasi (WasiConfig config)
void	set_epoch_deadline (uint64_t ticks_beyond_current)
wasmtime_context_t *	raw_context ()
	Returns the raw context pointer for the C API.

Detailed Description

An interior pointer into a Store.

A Context object is created from either a Store or a Caller. It is an interior pointer into a Store and cannot be used outside the lifetime of the original object it was created from.

This object is an argument to most APIs in Wasmtime but typically doesn't need to be constructed explicitly since it can be created from a Store& or a Caller&.

Member Function Documentation

gc()

void wasmtime::Store::Context::gc ( )

inline

Runs a garbage collection pass in the referenced store to collect loose externref values, if any are available.

get_fuel()

Result< uint64_t > wasmtime::Store::Context::get_fuel ( ) const

inline

Returns the amount of fuel consumed so far by executing WebAssembly.

Returns std::nullopt if fuel consumption is not enabled.

set_epoch_deadline()

void wasmtime::Store::Context::set_epoch_deadline ( uint64_t  ticks_beyond_current )

inline

Configures this store's epoch deadline to be the specified number of ticks beyond the engine's current epoch.

By default the deadline is the current engine's epoch, immediately interrupting code if epoch interruption is enabled. This must be called to extend the deadline to allow interruption.

set_fuel()

Result< std::monostate > wasmtime::Store::Context::set_fuel ( uint64_t  fuel )

inline

Injects fuel to be consumed within this store.

Stores start with 0 fuel and if Config::consume_fuel is enabled then this is required if you want to let WebAssembly actually execute.

Returns an error if fuel consumption isn't enabled.

set_wasi()

Result< std::monostate > wasmtime::Store::Context::set_wasi ( WasiConfig  config )

inline

Configures the WASI state used by this store.

This will only have an effect if used in conjunction with Linker::define_wasi because otherwise no host functions will use the WASI state.

---

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

• include/wasmtime.hh