Trait wasmi::core::HostError

source · 
pub trait HostError: 'static + Display + Debug + DowncastSync { }
Expand description

Trait that allows the host to return custom error.

It should be useful for representing custom traps, troubles at instantiation time or other host specific conditions.

Types that implement this trait can automatically be converted to wasmi::Error and wasmi::Trap and will be represented as a boxed HostError. You can then use the various methods on wasmi::Error to get your custom error type back

§Examples

use std::fmt;
use wasmi_core::{Trap, HostError};

#[derive(Debug, Copy, Clone)]
struct MyError {
    code: u32,
}

impl fmt::Display for MyError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "MyError, code={}", self.code)
    }
}

impl HostError for MyError { }

fn failable_fn() -> Result<(), Trap> {
    let my_error = MyError { code: 42 };
    // Note how you can just convert your errors to `wasmi::Error`
    Err(my_error.into())
}

// Get a reference to the concrete error
match failable_fn() {
    Err(trap) => {
        let my_error: &MyError = trap.downcast_ref().unwrap();
        assert_eq!(my_error.code, 42);
    }
    _ => panic!(),
}

// get the concrete error itself
match failable_fn() {
    Err(err) => {
        let my_error = match err.downcast_ref::<MyError>() {
            Some(host_error) => host_error.clone(),
            None => panic!("expected host error `MyError` but found: {}", err),
        };
        assert_eq!(my_error.code, 42);
    }
    _ => panic!(),
}

Implementations§

source§

impl dyn HostError

source

pub fn is<__T>(&self) -> bool
where __T: HostError,

Returns true if the trait object wraps an object of type __T.

source

pub fn downcast<__T>( self: Box<dyn HostError>, ) -> Result<Box<__T>, Box<dyn HostError>>
where __T: HostError,

Returns a boxed object from a boxed trait object if the underlying object is of type __T. Returns the original boxed trait if it isn’t.

source

pub fn downcast_rc<__T>( self: Rc<dyn HostError>, ) -> Result<Rc<__T>, Rc<dyn HostError>>
where __T: HostError,

Returns an Rc-ed object from an Rc-ed trait object if the underlying object is of type __T. Returns the original Rc-ed trait if it isn’t.

source

pub fn downcast_ref<__T>(&self) -> Option<&__T>
where __T: HostError,

Returns a reference to the object within the trait object if it is of type __T, or None if it isn’t.

source

pub fn downcast_mut<__T>(&mut self) -> Option<&mut __T>
where __T: HostError,

Returns a mutable reference to the object within the trait object if it is of type __T, or None if it isn’t.

Implementors§