diff --git a/units/src/amount.rs b/units/src/amount.rs index a8988a49..21c1b713 100644 --- a/units/src/amount.rs +++ b/units/src/amount.rs @@ -988,34 +988,38 @@ impl Amount { // Some arithmetic that doesn't fit in `core::ops` traits. /// Checked addition. + /// /// Returns [None] if overflow occurred. pub fn checked_add(self, rhs: Amount) -> Option { self.0.checked_add(rhs.0).map(Amount) } /// Checked subtraction. + /// /// Returns [None] if overflow occurred. pub fn checked_sub(self, rhs: Amount) -> Option { self.0.checked_sub(rhs.0).map(Amount) } /// Checked multiplication. + /// /// Returns [None] if overflow occurred. pub fn checked_mul(self, rhs: u64) -> Option { self.0.checked_mul(rhs).map(Amount) } /// Checked integer division. + /// /// Be aware that integer division loses the remainder if no exact division /// can be made. /// Returns [None] if overflow occurred. pub fn checked_div(self, rhs: u64) -> Option { self.0.checked_div(rhs).map(Amount) } /// Checked remainder. + /// /// Returns [None] if overflow occurred. pub fn checked_rem(self, rhs: u64) -> Option { self.0.checked_rem(rhs).map(Amount) } /// Unchecked addition. /// - /// /// Computes `self + rhs`. Panics in debug mode, wraps in release mode. pub fn unchecked_add(self, rhs: Amount) -> Amount { Self(self.0 + rhs.0)