Prevent default derives for Forward declared types.

We do not know the layout for forward declared types. Deriving Copy, Clone, Hash, PartialEq etc. is simply wrong. Deriving Debug is debatable. The default derive might give a wrong impression, since it prints out the inner unused field. The opt-in manual implementation would print opaque, which seems friendlier. Changed tests: - func-return-must-use: Don't use forward declared structs in the test, since that would result in wrong bindings! - issue-1238-fwd-no-copy test no longer requires an annotation, since Forward declared types should always be no copy
rust-lang · Feb 2, 2025 · c196db6 · c196db6
1 parent 03d49b6
commit c196db6
Show file tree

Hide file tree

Showing 21 changed files with 41 additions and 37 deletions.
diff --git a/bindgen-tests/tests/expectations/tests/anon_union.rs b/bindgen-tests/tests/expectations/tests/anon_union.rs
diff --git a/bindgen-tests/tests/expectations/tests/forward-declaration-autoptr.rs b/bindgen-tests/tests/expectations/tests/forward-declaration-autoptr.rs
diff --git a/bindgen-tests/tests/expectations/tests/forward_declared_complex_types.rs b/bindgen-tests/tests/expectations/tests/forward_declared_complex_types.rs
diff --git a/bindgen-tests/tests/expectations/tests/forward_declared_opaque.rs b/bindgen-tests/tests/expectations/tests/forward_declared_opaque.rs
diff --git a/bindgen-tests/tests/expectations/tests/func_return_must_use.rs b/bindgen-tests/tests/expectations/tests/func_return_must_use.rs
diff --git a/bindgen-tests/tests/expectations/tests/issue-1238-fwd-no-copy.rs b/bindgen-tests/tests/expectations/tests/issue-1238-fwd-no-copy.rs
diff --git a/bindgen-tests/tests/expectations/tests/issue-1443.rs b/bindgen-tests/tests/expectations/tests/issue-1443.rs
diff --git a/bindgen-tests/tests/expectations/tests/issue-654-struct-fn-collision.rs b/bindgen-tests/tests/expectations/tests/issue-654-struct-fn-collision.rs
diff --git a/bindgen-tests/tests/expectations/tests/issue-710-must-use-type.rs b/bindgen-tests/tests/expectations/tests/issue-710-must-use-type.rs
diff --git a/bindgen-tests/tests/expectations/tests/issue-801-opaque-sloppiness.rs b/bindgen-tests/tests/expectations/tests/issue-801-opaque-sloppiness.rs
diff --git a/bindgen-tests/tests/expectations/tests/layout_array.rs b/bindgen-tests/tests/expectations/tests/layout_array.rs
diff --git a/bindgen-tests/tests/expectations/tests/operator.rs b/bindgen-tests/tests/expectations/tests/operator.rs
diff --git a/bindgen-tests/tests/expectations/tests/parm-union.rs b/bindgen-tests/tests/expectations/tests/parm-union.rs
diff --git a/bindgen-tests/tests/expectations/tests/same_struct_name_in_different_namespaces.rs b/bindgen-tests/tests/expectations/tests/same_struct_name_in_different_namespaces.rs
diff --git a/bindgen-tests/tests/expectations/tests/template.rs b/bindgen-tests/tests/expectations/tests/template.rs
diff --git a/bindgen-tests/tests/expectations/tests/typedef-pointer-overlap.rs b/bindgen-tests/tests/expectations/tests/typedef-pointer-overlap.rs
diff --git a/bindgen-tests/tests/expectations/tests/wrap-static-fns.rs b/bindgen-tests/tests/expectations/tests/wrap-static-fns.rs
diff --git a/bindgen-tests/tests/expectations/tests/wrap_unsafe_ops_anon_union.rs b/bindgen-tests/tests/expectations/tests/wrap_unsafe_ops_anon_union.rs
diff --git a/bindgen-tests/tests/headers/func_return_must_use.h b/bindgen-tests/tests/headers/func_return_must_use.h
@@ -4,7 +4,9 @@ typedef int MustUseInt;
 
 MustUseInt return_int();
 
-struct MustUseStruct;
+struct MustUseStruct {
+    int a;
+};
 
 struct MustUseStruct return_struct();
 
@@ -20,11 +22,15 @@ int return_plain_int();
 /**
  * <div rustbindgen mustusetype></div>
  */
-struct AnnotatedStruct {};
+struct AnnotatedStruct {
+    int a;
+};
 
 struct AnnotatedStruct return_annotated_struct();
 
-struct PlainStruct {};
+struct PlainStruct {
+    int a;
+};
 
 /**
  * <div rustbindgen mustusetype></div>

diff --git a/bindgen-tests/tests/headers/issue-1238-fwd-no-copy.h b/bindgen-tests/tests/headers/issue-1238-fwd-no-copy.h
@@ -1,3 +1,2 @@
-// bindgen-flags: --no-copy MyType
 
 typedef struct MyType MyTypeT;
diff --git a/bindgen/codegen/mod.rs b/bindgen/codegen/mod.rs
@@ -2444,7 +2444,14 @@ impl CodeGenerator for CompInfo {
             }
         }
 
-        let derivable_traits = derives_of_item(item, ctx, packed);
+        let derivable_traits = if self.is_forward_declaration() {
+            // The only trait we could derive for forward declared types is `Debug`.
+            // However, since we don't actually know anything about the type, the
+            // Debug implementation would be useless.
+            DerivableTraits::empty()
+        } else {
+            derives_of_item(item, ctx, packed)
+        };
         if !derivable_traits.contains(DerivableTraits::DEBUG) {
             needs_debug_impl = ctx.options().derive_debug &&
                 ctx.options().impl_debug &&
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,2 @@
		// bindgen-flags: --no-copy MyType

		typedef struct MyType MyTypeT;