linux-kernel - [PATCH] rust: num: clean up Bounded::_

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20260123132132.53854-1-shivamklr@cock.li>
Date: Fri, 23 Jan 2026 18:51:13 +0530
From: Shivam Kalra <shivamklr@...k.li>
To: Miguel Ojeda <ojeda@...nel.org>
Cc: Shivam Kalra <shivamklr@...k.li>,
	Alexandre Courbot <acourbot@...dia.com>,
	rust-for-linux@...r.kernel.org,
	linux-kernel@...r.kernel.org
Subject: [PATCH] rust: num: clean up Bounded::__new documentation and comments

Remove the redundant paragraph in the documentation of __new now that
the Safety section explicitly covers the requirement. Additionally,
add an INVARIANT comment inside the function body where the Bounded
instance is actually constructed to document that the type invariant
is upheld.

Link: https://lore.kernel.org/rust-for-linux/CANiq72mUCUh72BWP4eD1PTDpwdb1ML+Xgfom-Ys6thJooqQPwQ@mail.gmail.com/.
Suggested-by: Miguel Ojeda <ojeda@...nel.org>
Signed-off-by: Shivam Kalra <shivamklr@...k.li>
---
 rust/kernel/num/bounded.rs | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/rust/kernel/num/bounded.rs b/rust/kernel/num/bounded.rs
index 5ef8361cf..fa81acbdc 100644
--- a/rust/kernel/num/bounded.rs
+++ b/rust/kernel/num/bounded.rs
@@ -282,9 +282,6 @@ impl<T, const N: u32> Bounded<T, N>
     /// All instances of [`Bounded`] must be created through this method as it enforces most of the
     /// type invariants.
     ///
-    /// The caller remains responsible for checking, either statically or dynamically, that `value`
-    /// can be represented as a `T` using at most `N` bits.
-    ///
     /// # Safety
     ///
     /// The caller must ensure that `value` can be represented within `N` bits.
@@ -297,6 +294,7 @@ impl<T, const N: u32> Bounded<T, N>
             assert!(N <= T::BITS);
         }
 
+        // INVARIANT: The caller ensures `value` fits within `N` bits.
         Self(value)
     }
 
-- 
2.43.0