Update doc comment for RuntimeError

This commit is contained in:
Mark McCaskey 2020-04-29 13:46:57 -07:00
parent 0cba64b538
commit 579d4564eb

View File

@ -242,13 +242,12 @@ impl std::fmt::Display for InvokeError {
} }
} }
/// An `InternalError` is an error that happened inside of Wasmer and is a /// A `RuntimeError` is an error that describes why the attempt to fully execute
/// catch-all for errors that would otherwise be returned as /// some Wasm has failed.
/// `RuntimeError(Box::new(<string>))`.
/// ///
/// This type provides greater visibility into the kinds of things that may fail /// These reasons vary from the Wasm trapping or otherwise failing directly to user
/// and improves the ability of users to handle them, though these errors may be /// controlled conditions such as metering running out of gas or a user host function
/// extremely rare and impossible to handle. /// returning a custom error type directly.
#[derive(Debug)] #[derive(Debug)]
pub enum RuntimeError { pub enum RuntimeError {
/// An error relating to the invocation of a Wasm function. /// An error relating to the invocation of a Wasm function.