bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Fix comments for unsigned non-zero checked_add, saturating_add

Browse source 
For these two methods, `other` is an ordinary unsigned integer, so it can be zero.

Since the sum of non-zero and zero is always non-zero, the safety argument
holds even when `other` is zero.
This commit is contained in:
Zalathar 2023-11-27 21:05:28 +11:00
parent 49b3924bd4
commit 00d5f18954
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
library/core/src/num/nonzero.rs
View file

@ -355,7 +355,7 @@ macro_rules! nonzero_unsigned_operations {
if let Some(result) = self.get().checked_add(other) { if let Some(result) = self.get().checked_add(other) {
// SAFETY: // SAFETY:
// - `checked_add` returns `None` on overflow // - `checked_add` returns `None` on overflow
// - `self` and `other` are non-zero // - `self` is non-zero
// - the only way to get zero from an addition without overflow is for both // - the only way to get zero from an addition without overflow is for both
// sides to be zero // sides to be zero
// //
@ -393,7 +393,7 @@ macro_rules! nonzero_unsigned_operations {
pub const fn saturating_add(self, other: $Int) -> $Ty { pub const fn saturating_add(self, other: $Int) -> $Ty {
// SAFETY: // SAFETY:
// - `saturating_add` returns `u*::MAX` on overflow, which is non-zero // - `saturating_add` returns `u*::MAX` on overflow, which is non-zero
// - `self` and `other` are non-zero // - `self` is non-zero
// - the only way to get zero from an addition without overflow is for both // - the only way to get zero from an addition without overflow is for both
// sides to be zero // sides to be zero
// //