diff options
| author | Zalathar <Zalathar@users.noreply.github.com> | 2023-11-27 21:05:28 +1100 |
|---|---|---|
| committer | Zalathar <Zalathar@users.noreply.github.com> | 2023-11-28 11:52:30 +1100 |
| commit | 00d5f189543f795291ab55522879dd80e2fce954 (patch) | |
| tree | 6c7108600225c6f9ea84c42f04d6d735738d8f13 | |
| parent | 49b3924bd4a34d3cf9c37b74120fba78d9712ab8 (diff) | |
| download | rust-00d5f189543f795291ab55522879dd80e2fce954.tar.gz rust-00d5f189543f795291ab55522879dd80e2fce954.zip | |
Fix comments for unsigned non-zero `checked_add`, `saturating_add`
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.
| -rw-r--r-- | library/core/src/num/nonzero.rs | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/library/core/src/num/nonzero.rs b/library/core/src/num/nonzero.rs index 530221c237c..f5ecf501ce9 100644 --- a/library/core/src/num/nonzero.rs +++ b/library/core/src/num/nonzero.rs @@ -355,7 +355,7 @@ macro_rules! nonzero_unsigned_operations { if let Some(result) = self.get().checked_add(other) { // SAFETY: // - `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 // sides to be zero // @@ -393,7 +393,7 @@ macro_rules! nonzero_unsigned_operations { pub const fn saturating_add(self, other: $Int) -> $Ty { // SAFETY: // - `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 // sides to be zero // |
