xeos
/
wasmi
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document conditions where NotResumable and AlreadyStarted error is returned

This commit is contained in:
Wei Tang 2018-07-09 23:32:30 +08:00
parent add6037e10
commit 0f0a28e9bd
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/func.rs
View File

@ -199,8 +199,21 @@ pub enum ResumableError {
/// Trap happened. /// Trap happened.
Trap(Trap), Trap(Trap),
/// The invocation is not resumable. /// The invocation is not resumable.
///
/// Invocations are only resumable if a host function is called, and the host function returns a trap of `Host` kind. For other cases, this error will be returned. This includes:
/// - The invocation is directly a host function.
/// - The invocation has not been started.
/// - The invocation returns normally or returns any trap other than `Host` kind.
///
/// This error is returned by [`resume_execution`].
///
/// [`resume_execution`]: struct.FuncInvocation.html#method.resume_execution
NotResumable, NotResumable,
/// The invocation has already been started. /// The invocation has already been started.
///
/// This error is returned by [`start_execution`].
///
/// [`start_execution`]: struct.FuncInvocation.html#method.start_execution
AlreadyStarted, AlreadyStarted,
} }
@ -271,8 +284,8 @@ impl<'args> FuncInvocation<'args> {
/// `UnexpectedSignature` trap will be returned. The current invocation must also be resumable /// `UnexpectedSignature` trap will be returned. The current invocation must also be resumable
/// [`is_resumable`]. Otherwise, a `NotResumable` error will be returned. /// [`is_resumable`]. Otherwise, a `NotResumable` error will be returned.
/// ///
/// [`resumable_value_type`]: struct.FuncInvocation.html#method.resumable_value_type /// [`resumable_value_type`]: #method.resumable_value_type
/// [`is_resumable`]: struct.FuncInvocation.html#method.is_resumable /// [`is_resumable`]: #method.is_resumable
pub fn resume_execution<'externals, E: Externals + 'externals>(&mut self, return_val: Option<RuntimeValue>, externals: &'externals mut E) -> Result<Option<RuntimeValue>, ResumableError> { pub fn resume_execution<'externals, E: Externals + 'externals>(&mut self, return_val: Option<RuntimeValue>, externals: &'externals mut E) -> Result<Option<RuntimeValue>, ResumableError> {
match self.kind { match self.kind {
FuncInvocationKind::Internal(ref mut interpreter) => { FuncInvocationKind::Internal(ref mut interpreter) => {