traiter/numbers/checked_div_rem.rs
1use core::ops::Rem;
2
3pub trait CheckedDivRem<Divisor = Self> {
4 type Output;
5
6 /// Returns quotient and remainder of checked division.
7 /// ```
8 /// use traiter::numbers::CheckedDivRem;
9 /// // signed integers
10 /// assert_eq!(
11 /// CheckedDivRem::checked_div_rem(-3i8, 2i8), Some((-1i8, -1i8))
12 /// );
13 /// assert_eq!(
14 /// CheckedDivRem::checked_div_rem(-3i8, 1i8), Some((-3i8, 0i8))
15 /// );
16 /// assert_eq!(CheckedDivRem::checked_div_rem(-3i8, 0i8), None);
17 /// assert_eq!(CheckedDivRem::checked_div_rem(i8::MIN, -1i8), None);
18 /// // unsigned integers
19 /// assert_eq!(CheckedDivRem::checked_div_rem(3u8, 2u8), Some((1u8, 1u8)));
20 /// assert_eq!(CheckedDivRem::checked_div_rem(3u8, 1u8), Some((3u8, 0u8)));
21 /// assert_eq!(CheckedDivRem::checked_div_rem(3u8, 0u8), None);
22 /// ```
23 fn checked_div_rem(self, divisor: Divisor) -> Self::Output;
24}
25
26macro_rules! integer_checked_div_rem_impl {
27 ($($integer:ty)*) => ($(
28 impl CheckedDivRem for $integer {
29 type Output = Option<(Self, Self)>;
30
31 #[inline(always)]
32 fn checked_div_rem(self, divisor: Self) -> Self::Output {
33 <$integer>::checked_div(self, divisor)
34 .map(|quotient| (quotient, <$integer>::rem(self, divisor)))
35 }
36 }
37 )*)
38}
39
40integer_checked_div_rem_impl!(
41 i8 i16 i32 i64 i128 isize u8 u16 u32 u64 u128 usize
42);