Seal HostFunctionKind trait

wasmerio · Aug 5, 2022 · dcb3497 · dcb3497
1 parent f8f1265
commit dcb3497
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/lib/api/src/js/externals/function.rs b/lib/api/src/js/externals/function.rs
@@ -901,7 +901,7 @@ mod inner {
     /// the trait system to automatically generate the appropriate
     /// host functions.
     #[doc(hidden)]
-    pub trait HostFunctionKind {}
+    pub trait HostFunctionKind: private::HostFunctionKindSealed {}
 
     /// An empty struct to help Rust typing to determine
     /// when a `HostFunction` does have an environment.
@@ -915,6 +915,16 @@ mod inner {
 
     impl HostFunctionKind for WithoutEnv {}
 
+    mod private {
+        //! Sealing the HostFunctionKind because it shouldn't be implemented
+        //! by any type outside.
+        //! See:
+        //! https://rust-lang.github.io/api-guidelines/future-proofing.html#c-sealed
+        pub trait HostFunctionKindSealed {}
+        impl HostFunctionKindSealed for super::WithEnv {}
+        impl HostFunctionKindSealed for super::WithoutEnv {}
+    }
+
     /// Represents a low-level Wasm static host function. See
     /// `super::Function::new` and `super::Function::new_env` to learn
     /// more.

diff --git a/lib/api/src/sys/externals/function.rs b/lib/api/src/sys/externals/function.rs
@@ -1119,6 +1119,16 @@ mod inner {
 
     impl HostFunctionKind for WithoutEnv {}
 
+    mod private {
+        //! Sealing the HostFunctionKind because it shouldn't be implemented
+        //! by any type outside.
+        //! See:
+        //! https://rust-lang.github.io/api-guidelines/future-proofing.html#c-sealed
+        pub trait HostFunctionKindSealed {}
+        impl HostFunctionKindSealed for super::WithEnv {}
+        impl HostFunctionKindSealed for super::WithoutEnv {}
+    }
+
     /// Represents a low-level Wasm static host function. See
     /// [`super::Function::new_typed`] and
     /// [`super::Function::new_typed_with_env`] to learn more.