From 385aa3fbaef7147d0637416b3eef0d0cf943e0e3 Mon Sep 17 00:00:00 2001 From: Wei Tang Date: Mon, 9 Jul 2018 23:34:57 +0800 Subject: [PATCH] Warn user that invoke_resumable is experimental --- src/func.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/func.rs b/src/func.rs index 514d538..109354e 100644 --- a/src/func.rs +++ b/src/func.rs @@ -155,16 +155,20 @@ impl FuncInstance { } } - /// Invoke the function, get a resumable handle. This handle can then be used to actually start the execution. If a - /// Host trap happens, caller can use `resume_execution` to feed the expected return value back in, and then + /// Invoke the function, get a resumable handle. This handle can then be used to [`start_execution`]. If a + /// Host trap happens, caller can use [`resume_execution`] to feed the expected return value back in, and then /// continue the execution. /// + /// This is an experimental API, and this functionality may not be available in other WebAssembly engines. + /// /// # Errors /// /// Returns `Err` if `args` types is not match function [`signature`]. /// /// [`signature`]: #method.signature /// [`Trap`]: #enum.Trap.html + /// [`start_execution`]: struct.FuncInvocation.html#method.start_execution + /// [`resume_execution`]: struct.FuncInvocation.html#method.resume_execution pub fn invoke_resumable<'args>( func: &FuncRef, args: &'args [RuntimeValue],