warn for UB on bit shifting

NLnetLabs · Dec 12, 2023 · 6c2c160 · 6c2c160
1 parent 1da2697
commit 6c2c160
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/af.rs b/src/af.rs
@@ -103,7 +103,7 @@ impl AddressFamily for IPv4 {
     /// //                       prefix   nibble
     /// ```
     ///
-    /// # Panics
+    /// # Panics in debug mode!
     ///
     /// Will panic if there is insufficient space to add the given nibble,
     /// i.e. if `len + nibble_len >= 32`.
@@ -187,8 +187,10 @@ impl AddressFamily for IPv6 {
     /// //                       prefix    nibble
     /// ```
     ///
-    /// # Panics
+    /// # Panics only in debug mode!
     ///
+    /// In release mode this will be UB (Undefined Behaviour)!
+    /// 
     /// Will panic if there is insufficient space to add the given nibble,
     /// i.e. if `len + nibble_len >= 128`.
     ///