Struct wasmtime::Trap

pub struct Trap { /* private fields */ }

A struct representing an aborted instruction execution, with a message indicating the cause.

Implementations

impl Trap

pub fn new<I: Into<String>>(message: I) -> Self

Creates a new Trap with message.

Example

let trap = wasmtime::Trap::new("unexpected error");
assert!(trap.to_string().contains("unexpected error"));

pub fn i32_exit(status: i32) -> Self

Creates a new Trap representing an explicit program exit with a classic i32 exit status value.

pub fn i32_exit_status(&self) -> Option<i32>

If the trap was the result of an explicit program exit with a classic i32 exit status value, return the value, otherwise return None.

pub fn display_reason<'a>(&'a self) -> impl Display + 'a

Displays the error reason for this trap.

In particular, it differs from this struct’s Display by only showing the reason, and not the full backtrace. This is useful to customize the way the trap is reported, for instance to display a short message for user-facing errors.

pub fn trace(&self) -> Option<&[FrameInfo]>

Returns a list of function frames in WebAssembly code that led to this trap happening.

This function return an Option of a list of frames to indicate that wasm frames are not always available. Frames will never be available if backtraces are disabled via Config::wasm_backtrace. Frames will also not be available for freshly-created traps. WebAssembly frames are currently only captured when the trap reaches wasm itself to get raised across a wasm boundary.

pub fn trap_code(&self) -> Option<TrapCode>

Code of a trap that happened while executing a WASM instruction. If the trap was triggered by a host export this will be None.

Trait Implementations

impl Clone for Trap

fn clone(&self) -> Trap

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Trap

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

Formats the value using the given formatter.

impl Display for Trap

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

Formats the value using the given formatter.

impl Error for Trap

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Box<dyn Error + Send + Sync + 'static, Global>> for Trap

fn from(e: Box<dyn Error + Send + Sync>) -> Trap

Performs the conversion.

impl From<Error> for Trap

fn from(e: Error) -> Trap

Performs the conversion.