Struct WasmCoreDump

pub struct WasmCoreDump { /* private fields */ }

Available on crate features coredump and runtime only.

Representation of a core dump of a WebAssembly module

When the Config::coredump_on_trap option is enabled this structure is attached to the anyhow::Error returned from many Wasmtime functions that execute WebAssembly such as Instance::new or Func::call. This can be acquired with the anyhow::Error::downcast family of methods to programmatically inspect the coredump. Otherwise since it’s part of the error returned this will get printed along with the rest of the error when the error is logged.

Note that some state, such as Wasm locals or values on the operand stack, may be optimized away by the compiler or otherwise not recovered in the coredump.

Capturing of wasm coredumps can be configured through the Config::coredump_on_trap method.

For more information about errors in wasmtime see the documentation of the Trap type.

Implementations

impl WasmCoreDump

pub fn frames(&self) -> &[FrameInfo]

The stack frames for this core dump.

Frames appear in callee to caller order, that is youngest to oldest frames.

pub fn modules(&self) -> &[Module]

All modules instantiated inside the store when the core dump was created.

pub fn instances(&self) -> &[Instance]

All instances within the store when the core dump was created.

pub fn globals(&self) -> &[Global]

All globals, instance- or host-defined, within the store when the core dump was created.

pub fn memories(&self) -> &[Memory]

All memories, instance- or host-defined, within the store when the core dump was created.

pub fn serialize(&self, store: impl AsContextMut, name: &str) -> Vec<u8>

Serialize this core dump into the standard core dump binary format.

The name parameter may be a file path, URL, or arbitrary name for the “main” Wasm service or executable that was running in this store.

Once serialized, you can write this core dump to disk, send it over the network, or pass it to other debugging tools that consume Wasm core dumps.

Trait Implementations

impl Debug for WasmCoreDump

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for WasmCoreDump

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.