Merge #2478

2478: Rename wasm_instance_new()’s “traps” argument to “trap”. r=syrusakbary a=FGasper Issue #2472 # Description This clarifies a bit how to properly use the error-handling mechanism in `wasm_instance_new()`, which only produces 0 or 1 traps, not 2+ as the name “traps” implies. # Review - [ ] Add a short description of the change to the CHANGELOG.md file Co-authored-by: Felipe Gasper <[email protected]>
wasmerio · Jul 17, 2021 · 784b85e · 784b85e
2 parents e916643 + d8cd757
commit 784b85e
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 17 deletions.
diff --git a/lib/c-api/examples/features.c b/lib/c-api/examples/features.c
@@ -40,8 +40,8 @@ int main(int argc, const char* argv[]) {
 
     printf("Instantiating module...\n");
     wasm_extern_vec_t imports = WASM_EMPTY_VEC;
-    wasm_trap_t* traps = NULL;
-    wasm_instance_t* instance = wasm_instance_new(store, module, &imports,&traps);
+    wasm_trap_t* trap = NULL;
+    wasm_instance_t* instance = wasm_instance_new(store, module, &imports,&trap);
 
     if (!instance) {
         printf("> Error instantiating module!\n");

diff --git a/lib/c-api/src/wasm_c_api/externals/mod.rs b/lib/c-api/src/wasm_c_api/externals/mod.rs
@@ -275,9 +275,9 @@ mod tests {
                 assert(module);
 
                 wasm_extern_vec_t imports = WASM_EMPTY_VEC;
-                wasm_trap_t* traps = NULL;
+                wasm_trap_t* trap = NULL;
 
-                wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &traps);
+                wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &trap);
                 assert(instance);
 
                 wasm_extern_vec_t exports;

diff --git a/lib/c-api/src/wasm_c_api/instance.rs b/lib/c-api/src/wasm_c_api/instance.rs
@@ -25,7 +25,7 @@ pub struct wasm_instance_t {
 /// 2. Runtime errors that happen when running the module `start`
 ///    function.
 ///
-/// Failures are stored in the `traps` argument; the program doesn't
+/// The failure is stored in the `trap` argument; the program doesn't
 /// panic.
 ///
 /// # Notes
@@ -41,7 +41,7 @@ pub unsafe extern "C" fn wasm_instance_new(
     _store: Option<&wasm_store_t>,
     module: Option<&wasm_module_t>,
     imports: Option<&wasm_extern_vec_t>,
-    traps: *mut *mut wasm_trap_t,
+    trap: *mut *mut wasm_trap_t,
 ) -> Option<Box<wasm_instance_t>> {
     let module = module?;
     let imports = imports?;
@@ -68,7 +68,7 @@ pub unsafe extern "C" fn wasm_instance_new(
 
         Err(InstantiationError::Start(runtime_error)) => {
             let trap: Box<wasm_trap_t> = Box::new(runtime_error.into());
-            *traps = Box::into_raw(trap);
+            *trap = Box::into_raw(trap);
 
             return None;
         }
@@ -124,9 +124,9 @@ pub unsafe extern "C" fn wasm_instance_delete(_instance: Option<Box<wasm_instanc
 ///
 ///     // Instantiate the module.
 ///     wasm_extern_vec_t imports = WASM_EMPTY_VEC;
-///     wasm_trap_t* traps = NULL;
+///     wasm_trap_t* trap = NULL;
 ///
-///     wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &traps);
+///     wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &trap);
 ///     assert(instance);
 ///
 ///     // Read the exports.
@@ -252,8 +252,8 @@ mod tests {
                 wasm_extern_vec_t imports = WASM_ARRAY_VEC(externs);
 
                 // Instantiate the module.
-                wasm_trap_t* traps = NULL;
-                wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &traps);
+                wasm_trap_t* trap = NULL;
+                wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &trap);
 
                 assert(instance);
 

diff --git a/lib/c-api/src/wasm_c_api/mod.rs b/lib/c-api/src/wasm_c_api/mod.rs
@@ -102,9 +102,9 @@ pub mod externals;
 ///
 ///     // Instantiate the module.
 ///     wasm_extern_vec_t imports = WASM_EMPTY_VEC;
-///     wasm_trap_t* traps = NULL;
+///     wasm_trap_t* trap = NULL;
 ///
-///     wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &traps);
+///     wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &trap);
 ///     assert(instance);
 ///
 ///     // Now do something with the instance, like calling the

diff --git a/lib/c-api/src/wasm_c_api/unstable/middlewares/metering.rs b/lib/c-api/src/wasm_c_api/unstable/middlewares/metering.rs
@@ -66,8 +66,8 @@
 //!     
 //!     // Instantiate the module.
 //!     wasm_extern_vec_t imports = WASM_EMPTY_VEC;
-//!     wasm_trap_t* traps = NULL;
-//!     wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &traps);
+//!     wasm_trap_t* trap = NULL;
+//!     wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &trap);
 //!     assert(instance);
 //!     
 //!     // Here we go. At this step, we will get the `add_two` exported function, and
@@ -269,8 +269,8 @@ pub extern "C" fn wasmer_metering_points_are_exhausted(instance: &wasm_instance_
 ///     assert(module);
 ///     
 ///     wasm_extern_vec_t imports = WASM_EMPTY_VEC;
-///     wasm_trap_t* traps = NULL;
-///     wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &traps);
+///     wasm_trap_t* trap = NULL;
+///     wasm_instance_t* instance = wasm_instance_new(store, module, &imports, &trap);
 ///     assert(instance);
 ///
 ///     // Read the number of points.