rtic-sync: add note about assert & update another to debug_assert

datdenkikniet · datdenkikniet · commit 25b6002f1024 · 2025-03-23T11:49:31.000+01:00
diff --git a/rtic-sync/src/channel.rs b/rtic-sync/src/channel.rs
@@ -110,6 +110,8 @@ impl<T, const N: usize> Channel<T, N> {
 
         // Fill free queue
         for idx in 0..N as u8 {
+            // NOTE(assert): `split`-ing does not put `freeq` into a known-empty
+            // state, so `debug_assert` is not good enough.
             assert!(!freeq.is_full());
 
             // SAFETY: This safe as the loop goes from 0 to the capacity of the underlying queue.
@@ -118,7 +120,7 @@ impl<T, const N: usize> Channel<T, N> {
             }
         }
 
-        assert!(freeq.is_full());
+        debug_assert!(freeq.is_full());
 
         // There is now 1 sender
         // SAFETY: we have exclusive access to `self`.

Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,8 @@ impl<T, const N: usize> Channel<T, N> {`
`110`	`110`
`111`	`111`	`// Fill free queue`
`112`	`112`	`for idx in 0..N as u8 {`
	`113`	+ // NOTE(assert): `split`-ing does not put `freeq` into a known-empty
	`114`	+ // state, so `debug_assert` is not good enough.
`113`	`115`	`assert!(!freeq.is_full());`
`114`	`116`
`115`	`117`	`// SAFETY: This safe as the loop goes from 0 to the capacity of the underlying queue.`
`@@ -118,7 +120,7 @@ impl<T, const N: usize> Channel<T, N> {`
`118`	`120`	`}`
`119`	`121`	`}`
`120`	`122`
`121`		`- assert!(freeq.is_full());`
	`123`	`+ debug_assert!(freeq.is_full());`
`122`	`124`
`123`	`125`	`// There is now 1 sender`
`124`	`126`	// SAFETY: we have exclusive access to `self`.