Struct soroban_wasmi::core::Trap

pub struct Trap { /* private fields */ }

Error type which can be returned by Wasm code or by the host environment.

Under some conditions, Wasm execution may produce a Trap, which immediately aborts execution. Traps cannot be handled by WebAssembly code, but are reported to the host embedder.

Implementations

impl Trap

pub fn new<T>(message: T) -> Trap

where T: Into<String>,

Creates a new Trap described by a message.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: HostError,

Downcasts the Trap into the T: HostError if possible.

Returns None otherwise.

pub fn downcast_mut<T>(&mut self) -> Option<&mut T>

where T: HostError,

Downcasts the Trap into the T: HostError if possible.

Returns None otherwise.

pub fn downcast<T>(self) -> Option<T>

where T: HostError,

Consumes self to downcast the Trap into the T: HostError if possible.

Returns None otherwise.

pub fn i32_exit(status: i32) -> Trap

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

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

Returns the classic i32 exit program code of a Trap if any.

Otherwise returns None.

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

Returns the TrapCode traps originating from Wasm execution.

Trait Implementations

impl Debug for Trap

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

Formats the value using the given formatter.

impl Display for Trap

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

Formats the value using the given formatter.

impl Error for Trap

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

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

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<E> From<E> for Trap

where E: HostError,

fn from(host_error: E) -> Trap

Converts to this type from the input type.

impl From<TrapCode> for Trap

fn from(error: TrapCode) -> Trap

Converts to this type from the input type.