capi: Add a not about exceptions thrown from host functions

wasmx · Mar 17, 2021 · 8ab6dba · 8ab6dba
1 parent 01b6963
commit 8ab6dba
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/include/fizzy/fizzy.h b/include/fizzy/fizzy.h
@@ -54,6 +54,10 @@ typedef struct FizzyExecutionResult
 /// @param  args        Pointer to the argument array. Can be NULL iff function has no inputs.
 /// @param  depth       Call stack depth.
 /// @return             Result of execution.
+///
+/// @note
+/// External functions implemented in C++ must be non-throwing, i.e. the effect of any exception
+/// escaping the function is std::terminate being called.
 typedef FizzyExecutionResult (*FizzyExternalFn)(
     void* context, FizzyInstance* instance, const FizzyValue* args, int depth);