Struct RuntimeError

pub struct RuntimeError {
    pub(crate) inner: Arc<RuntimeErrorInner>,
}

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

Fields

inner: Arc<RuntimeErrorInner>

Implementations

impl RuntimeError

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

Creates a new generic RuntimeError with the given message.

Example

let trap = wasmer::RuntimeError::new("unexpected error");
assert_eq!("unexpected error", trap.message());

pub fn new_from_source( source: Trap, wasm_trace: Vec<FrameInfo>, trap_code: Option<TrapCode>, ) -> Self

Creates RuntimeError from an error and a WasmTrace

Example

let wasm_trace = vec![wasmer_types::FrameInfo::new(
  "my_module".to_string(),
  0,
  Some("my_function".to_string()),
  0.into(),
  2.into()
)];
let trap = wasmer::RuntimeError::new_from_source(my_error, wasm_trace, None);
assert_eq!("unexpected error", trap.message());

pub fn user(error: Box<dyn Error + Send + Sync>) -> Self

Creates a custom user Error.

This error object can be passed through Wasm frames and later retrieved using the downcast method.

pub fn exception(ctx: &impl AsStoreRef, exception: Exception) -> Self

Creates a RuntimeError containing an exception.

If this error is returned from an imported function, the exception will be thrown in the WebAssembly code instead of the usual trapping.

pub fn message(&self) -> String

Returns a reference the message stored in Trap.

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

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

pub fn to_trap(self) -> Option<TrapCode>

Returns trap code, if it’s a Trap

pub fn downcast<T: Error + 'static>(self) -> Result<T, Self>

Attempts to downcast the RuntimeError to a concrete type.

pub fn downcast_ref<T: Error + 'static>(&self) -> Option<&T>

Attempts to downcast the RuntimeError to a concrete type.

pub fn is<T: Error + 'static>(&self) -> bool

Returns true if the RuntimeError is the same as T

pub fn is_exception(&self) -> bool

Returns true if the RuntimeError is an uncaught exception.

pub fn to_exception(&self) -> Option<Exception>

If the RuntimeError is an uncaught exception, returns it.

pub fn display<'a>( &'a self, store: &'a mut impl AsStoreMut, ) -> RuntimeErrorDisplay<'a>

Returns a displayable version of the RuntimeError that also shows exception payloads.

pub fn write_trace(trace: &[FrameInfo], f: &mut Formatter<'_>) -> Result

Write the WASM trace to the given formatter, if we have one.

Trait Implementations

impl Clone for RuntimeError

fn clone(&self) -> RuntimeError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeError

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

Formats the value using the given formatter.

impl Display for RuntimeError

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

Formats the value using the given formatter.

impl Error for RuntimeError

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

Returns the lower-level source of this error, if any.

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

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Box<dyn Error + Send + Sync>> for RuntimeError

fn from(error: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.

impl From<MemoryAccessError> for RuntimeError

fn from(err: MemoryAccessError) -> Self

Converts to this type from the input type.

impl From<Trap> for RuntimeError

fn from(trap: Trap) -> Self

Converts to this type from the input type.