Add some documentation on why/when async_cx can return None.

bytecodealliance · Mar 7, 2022 · 09d62a4 · 09d62a4
1 parent 382567f
commit 09d62a4
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/wasmtime/src/store.rs b/crates/wasmtime/src/store.rs
@@ -1294,6 +1294,10 @@ impl StoreOpaque {
         panic!("trampoline missing")
     }
 
+    /// Yields the async context, assuming that we are executing on a fiber and
+    /// that fiber is not in the process of dying. This function will return
+    /// None in the latter case (the fiber is dying), and panic if
+    /// `async_support()` is false.
     #[cfg(feature = "async")]
     #[inline]
     pub fn async_cx(&self) -> Option<AsyncCx> {