Add comment regarding load-bearing drop order

jamesmunns · jamesmunns · commit 72d752e37dd4 · 2022-11-14T13:58:43.000+01:00
diff --git a/src/test.rs b/src/test.rs
@@ -53,6 +53,9 @@ impl<const N: usize> Drop for Dropper<N> {
 
 pub struct OwnedHeap<const N: usize> {
     heap: Heap,
+    // /!\ SAFETY /!\: Load bearing drop order! `_drop` MUST be dropped AFTER
+    // `heap` is dropped. This is enforced by rust's built-in drop ordering, as
+    // long as `_drop` is declared after `heap`.
     _drop: Dropper<N>,
 }
 

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,9 @@ impl<const N: usize> Drop for Dropper<N> {`
`53`	`53`
`54`	`54`	`pub struct OwnedHeap<const N: usize> {`
`55`	`55`	`heap: Heap,`
	`56`	+ // /!\ SAFETY /!\: Load bearing drop order! `_drop` MUST be dropped AFTER
	`57`	+ // `heap` is dropped. This is enforced by rust's built-in drop ordering, as
	`58`	+ // long as `_drop` is declared after `heap`.
`56`	`59`	`_drop: Dropper<N>,`
`57`	`60`	`}`
`58`	`61`