use ALIGN for Push::alignment in struct types (#8398)

bkietz · web-flow · commit 49061f8c7c99 · 2024-10-28T08:42:55.000-07:00
* use ALIGN for Push::alignment in struct types

* regenerate and add a test for struct alignment
diff --git a/rust/flatbuffers/src/lib.rs b/rust/flatbuffers/src/lib.rs
@@ -52,7 +52,7 @@ pub use crate::builder::{Allocator, DefaultAllocator, FlatBufferBuilder};
 pub use crate::endian_scalar::{emplace_scalar, read_scalar, read_scalar_at, EndianScalar};
 pub use crate::follow::{Follow, FollowStart};
 pub use crate::primitives::*;
-pub use crate::push::Push;
+pub use crate::push::{Push, PushAlignment};
 pub use crate::table::{buffer_has_identifier, Table};
 pub use crate::vector::{follow_cast_ref, Vector, VectorIter};
 pub use crate::verifier::{
diff --git a/samples/rust_generated/my_game/sample/vec_3_generated.rs b/samples/rust_generated/my_game/sample/vec_3_generated.rs
@@ -50,6 +50,10 @@ impl<'b> flatbuffers::Push for Vec3 {
         let src = ::core::slice::from_raw_parts(self as *const Vec3 as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Vec3 {
diff --git a/src/idl_gen_rust.cpp b/src/idl_gen_rust.cpp
@@ -2703,6 +2703,10 @@ class RustGenerator : public BaseGenerator {
         "{{STRUCT_TY}} as *const u8, Self::size());";
     code_ += "        dst.copy_from_slice(src);";
     code_ += "    }";
+    code_ += "    #[inline]";
+    code_ += "    fn alignment() -> flatbuffers::PushAlignment {";
+    code_ += "        flatbuffers::PushAlignment::new({{ALIGN}})";
+    code_ += "    }";
     code_ += "}";
     code_ += "";
 
diff --git a/tests/arrays_test/my_game/example/array_struct_generated.rs b/tests/arrays_test/my_game/example/array_struct_generated.rs
@@ -53,6 +53,10 @@ impl<'b> flatbuffers::Push for ArrayStruct {
         let src = ::core::slice::from_raw_parts(self as *const ArrayStruct as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(8)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for ArrayStruct {
diff --git a/tests/arrays_test/my_game/example/nested_struct_generated.rs b/tests/arrays_test/my_game/example/nested_struct_generated.rs
@@ -51,6 +51,10 @@ impl<'b> flatbuffers::Push for NestedStruct {
         let src = ::core::slice::from_raw_parts(self as *const NestedStruct as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(8)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for NestedStruct {
diff --git a/tests/include_test1/my_game/other_name_space/unused_generated.rs b/tests/include_test1/my_game/other_name_space/unused_generated.rs
@@ -48,6 +48,10 @@ impl<'b> flatbuffers::Push for Unused {
         let src = ::core::slice::from_raw_parts(self as *const Unused as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Unused {
diff --git a/tests/include_test2/my_game/other_name_space/unused_generated.rs b/tests/include_test2/my_game/other_name_space/unused_generated.rs
@@ -48,6 +48,10 @@ impl<'b> flatbuffers::Push for Unused {
         let src = ::core::slice::from_raw_parts(self as *const Unused as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Unused {
diff --git a/tests/monster_test/my_game/example/ability_generated.rs b/tests/monster_test/my_game/example/ability_generated.rs
@@ -49,6 +49,10 @@ impl<'b> flatbuffers::Push for Ability {
         let src = ::core::slice::from_raw_parts(self as *const Ability as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Ability {
diff --git a/tests/monster_test/my_game/example/struct_of_structs_generated.rs b/tests/monster_test/my_game/example/struct_of_structs_generated.rs
@@ -50,6 +50,10 @@ impl<'b> flatbuffers::Push for StructOfStructs {
         let src = ::core::slice::from_raw_parts(self as *const StructOfStructs as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for StructOfStructs {
diff --git a/tests/monster_test/my_game/example/struct_of_structs_of_structs_generated.rs b/tests/monster_test/my_game/example/struct_of_structs_of_structs_generated.rs
@@ -48,6 +48,10 @@ impl<'b> flatbuffers::Push for StructOfStructsOfStructs {
         let src = ::core::slice::from_raw_parts(self as *const StructOfStructsOfStructs as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for StructOfStructsOfStructs {
diff --git a/tests/monster_test/my_game/example/test_generated.rs b/tests/monster_test/my_game/example/test_generated.rs
@@ -49,6 +49,10 @@ impl<'b> flatbuffers::Push for Test {
         let src = ::core::slice::from_raw_parts(self as *const Test as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(2)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Test {
diff --git a/tests/monster_test/my_game/example/vec_3_generated.rs b/tests/monster_test/my_game/example/vec_3_generated.rs
@@ -53,6 +53,10 @@ impl<'b> flatbuffers::Push for Vec3 {
         let src = ::core::slice::from_raw_parts(self as *const Vec3 as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(8)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Vec3 {
diff --git a/tests/monster_test/my_game/other_name_space/unused_generated.rs b/tests/monster_test/my_game/other_name_space/unused_generated.rs
@@ -48,6 +48,10 @@ impl<'b> flatbuffers::Push for Unused {
         let src = ::core::slice::from_raw_parts(self as *const Unused as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Unused {
diff --git a/tests/monster_test_serialize/my_game/example/ability_generated.rs b/tests/monster_test_serialize/my_game/example/ability_generated.rs
@@ -51,6 +51,10 @@ impl<'b> flatbuffers::Push for Ability {
         let src = ::core::slice::from_raw_parts(self as *const Ability as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Ability {
diff --git a/tests/monster_test_serialize/my_game/example/struct_of_structs_generated.rs b/tests/monster_test_serialize/my_game/example/struct_of_structs_generated.rs
@@ -52,6 +52,10 @@ impl<'b> flatbuffers::Push for StructOfStructs {
         let src = ::core::slice::from_raw_parts(self as *const StructOfStructs as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for StructOfStructs {
diff --git a/tests/monster_test_serialize/my_game/example/struct_of_structs_of_structs_generated.rs b/tests/monster_test_serialize/my_game/example/struct_of_structs_of_structs_generated.rs
@@ -50,6 +50,10 @@ impl<'b> flatbuffers::Push for StructOfStructsOfStructs {
         let src = ::core::slice::from_raw_parts(self as *const StructOfStructsOfStructs as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for StructOfStructsOfStructs {
diff --git a/tests/monster_test_serialize/my_game/example/test_generated.rs b/tests/monster_test_serialize/my_game/example/test_generated.rs
@@ -51,6 +51,10 @@ impl<'b> flatbuffers::Push for Test {
         let src = ::core::slice::from_raw_parts(self as *const Test as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(2)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Test {
diff --git a/tests/monster_test_serialize/my_game/example/vec_3_generated.rs b/tests/monster_test_serialize/my_game/example/vec_3_generated.rs
@@ -55,6 +55,10 @@ impl<'b> flatbuffers::Push for Vec3 {
         let src = ::core::slice::from_raw_parts(self as *const Vec3 as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(8)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Vec3 {
diff --git a/tests/monster_test_serialize/my_game/other_name_space/unused_generated.rs b/tests/monster_test_serialize/my_game/other_name_space/unused_generated.rs
@@ -50,6 +50,10 @@ impl<'b> flatbuffers::Push for Unused {
         let src = ::core::slice::from_raw_parts(self as *const Unused as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Unused {
diff --git a/tests/namespace_test/namespace_a/namespace_b/struct_in_nested_ns_generated.rs b/tests/namespace_test/namespace_a/namespace_b/struct_in_nested_ns_generated.rs
@@ -49,6 +49,10 @@ impl<'b> flatbuffers::Push for StructInNestedNS {
         let src = ::core::slice::from_raw_parts(self as *const StructInNestedNS as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for StructInNestedNS {
diff --git a/tests/private_annotation_test/object_generated.rs b/tests/private_annotation_test/object_generated.rs
@@ -48,6 +48,10 @@ impl<'b> flatbuffers::Push for Object {
         let src = ::core::slice::from_raw_parts(self as *const Object as *const u8, Self::size());
         dst.copy_from_slice(src);
     }
+    #[inline]
+    fn alignment() -> flatbuffers::PushAlignment {
+        flatbuffers::PushAlignment::new(4)
+    }
 }
 
 impl<'a> flatbuffers::Verifiable for Object {
diff --git a/tests/rust_usage_test/tests/integration_test.rs b/tests/rust_usage_test/tests/integration_test.rs
@@ -2422,6 +2422,14 @@ mod push_impls {
                     0, 0, 0, 0,
                     0, 0, 0, 1]);
     }
+
+    #[test]
+    fn push_u8_generated_struct_alignment() {
+        let mut b = flatbuffers::FlatBufferBuilder::new();
+        b.push(1u8);
+        b.push(my_game::example::Test::new(10, 20));
+        check(&b, &[10, 0, 20, 0, 0, 1]);
+    }
 }
 
 #[cfg(test)]

Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ impl<'b> flatbuffers::Push for Vec3 {`
`50`	`50`	`let src = ::core::slice::from_raw_parts(self as const Vec3 as const u8, Self::size());`
`51`	`51`	`dst.copy_from_slice(src);`
`52`	`52`	`}`
	`53`	`+ #[inline]`
	`54`	`+ fn alignment() -> flatbuffers::PushAlignment {`
	`55`	`+ flatbuffers::PushAlignment::new(4)`
	`56`	`+ }`
`53`	`57`	`}`
`54`	`58`
`55`	`59`	`impl<'a> flatbuffers::Verifiable for Vec3 {`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,10 @@ impl<'b> flatbuffers::Push for ArrayStruct {`
`53`	`53`	`let src = ::core::slice::from_raw_parts(self as const ArrayStruct as const u8, Self::size());`
`54`	`54`	`dst.copy_from_slice(src);`
`55`	`55`	`}`
	`56`	`+ #[inline]`
	`57`	`+ fn alignment() -> flatbuffers::PushAlignment {`
	`58`	`+ flatbuffers::PushAlignment::new(8)`
	`59`	`+ }`
`56`	`60`	`}`
`57`	`61`
`58`	`62`	`impl<'a> flatbuffers::Verifiable for ArrayStruct {`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,10 @@ impl<'b> flatbuffers::Push for NestedStruct {`
`51`	`51`	`let src = ::core::slice::from_raw_parts(self as const NestedStruct as const u8, Self::size());`
`52`	`52`	`dst.copy_from_slice(src);`
`53`	`53`	`}`
	`54`	`+ #[inline]`
	`55`	`+ fn alignment() -> flatbuffers::PushAlignment {`
	`56`	`+ flatbuffers::PushAlignment::new(8)`
	`57`	`+ }`
`54`	`58`	`}`
`55`	`59`
`56`	`60`	`impl<'a> flatbuffers::Verifiable for NestedStruct {`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,10 @@ impl<'b> flatbuffers::Push for Unused {`
`48`	`48`	`let src = ::core::slice::from_raw_parts(self as const Unused as const u8, Self::size());`
`49`	`49`	`dst.copy_from_slice(src);`
`50`	`50`	`}`
	`51`	`+ #[inline]`
	`52`	`+ fn alignment() -> flatbuffers::PushAlignment {`
	`53`	`+ flatbuffers::PushAlignment::new(4)`
	`54`	`+ }`
`51`	`55`	`}`
`52`	`56`
`53`	`57`	`impl<'a> flatbuffers::Verifiable for Unused {`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,10 @@ impl<'b> flatbuffers::Push for Ability {`
`49`	`49`	`let src = ::core::slice::from_raw_parts(self as const Ability as const u8, Self::size());`
`50`	`50`	`dst.copy_from_slice(src);`
`51`	`51`	`}`
	`52`	`+ #[inline]`
	`53`	`+ fn alignment() -> flatbuffers::PushAlignment {`
	`54`	`+ flatbuffers::PushAlignment::new(4)`
	`55`	`+ }`
`52`	`56`	`}`
`53`	`57`
`54`	`58`	`impl<'a> flatbuffers::Verifiable for Ability {`