      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127

    use core::ops::{Add, Sub, Mul};
    use core::num::Wrapping;

    macro_rules! wrapping_impl {
        ($trait_name:ident, $method:ident, $t:ty) => {
            impl $trait_name for $t {
                #[inline]
                fn $method(&self, v: &Self) -> Self {
                    <$t>::$method(*self, *v)
                }
            }
        };
        ($trait_name:ident, $method:ident, $t:ty, $rhs:ty) => {
            impl $trait_name<$rhs> for $t {
                #[inline]
                fn $method(&self, v: &$rhs) -> Self {
                    <$t>::$method(*self, *v)
                }
            }
        }
    }

    /// Performs addition that wraps around on overflow.
    pub trait WrappingAdd: Sized + Add<Self, Output=Self> {
        /// Wrapping (modular) addition. Computes `self + other`, wrapping around at the boundary of
        /// the type.
        fn wrapping_add(&self, v: &Self) -> Self;
    }

    wrapping_impl!(WrappingAdd, wrapping_add, u8);
    wrapping_impl!(WrappingAdd, wrapping_add, u16);
    wrapping_impl!(WrappingAdd, wrapping_add, u32);
    wrapping_impl!(WrappingAdd, wrapping_add, u64);
    wrapping_impl!(WrappingAdd, wrapping_add, usize);

    wrapping_impl!(WrappingAdd, wrapping_add, i8);
    wrapping_impl!(WrappingAdd, wrapping_add, i16);
    wrapping_impl!(WrappingAdd, wrapping_add, i32);
    wrapping_impl!(WrappingAdd, wrapping_add, i64);
    wrapping_impl!(WrappingAdd, wrapping_add, isize);

    /// Performs subtraction that wraps around on overflow.
    pub trait WrappingSub: Sized + Sub<Self, Output=Self> {
        /// Wrapping (modular) subtraction. Computes `self - other`, wrapping around at the boundary
        /// of the type.
        fn wrapping_sub(&self, v: &Self) -> Self;
    }

    wrapping_impl!(WrappingSub, wrapping_sub, u8);
    wrapping_impl!(WrappingSub, wrapping_sub, u16);
    wrapping_impl!(WrappingSub, wrapping_sub, u32);
    wrapping_impl!(WrappingSub, wrapping_sub, u64);
    wrapping_impl!(WrappingSub, wrapping_sub, usize);

    wrapping_impl!(WrappingSub, wrapping_sub, i8);
    wrapping_impl!(WrappingSub, wrapping_sub, i16);
    wrapping_impl!(WrappingSub, wrapping_sub, i32);
    wrapping_impl!(WrappingSub, wrapping_sub, i64);
    wrapping_impl!(WrappingSub, wrapping_sub, isize);

    /// Performs multiplication that wraps around on overflow.
    pub trait WrappingMul: Sized + Mul<Self, Output=Self> {
        /// Wrapping (modular) multiplication. Computes `self * other`, wrapping around at the boundary
        /// of the type.
        fn wrapping_mul(&self, v: &Self) -> Self;
    }

    wrapping_impl!(WrappingMul, wrapping_mul, u8);
    wrapping_impl!(WrappingMul, wrapping_mul, u16);
    wrapping_impl!(WrappingMul, wrapping_mul, u32);
    wrapping_impl!(WrappingMul, wrapping_mul, u64);
    wrapping_impl!(WrappingMul, wrapping_mul, usize);

    wrapping_impl!(WrappingMul, wrapping_mul, i8);
    wrapping_impl!(WrappingMul, wrapping_mul, i16);
    wrapping_impl!(WrappingMul, wrapping_mul, i32);
    wrapping_impl!(WrappingMul, wrapping_mul, i64);
    wrapping_impl!(WrappingMul, wrapping_mul, isize);

    // Well this is a bit funny, but all the more appropriate.
    impl<T: WrappingAdd> WrappingAdd for Wrapping<T> where Wrapping<T>: Add<Output = Wrapping<T>> {
        fn wrapping_add(&self, v: &Self) -> Self {
            Wrapping(self.0.wrapping_add(&v.0))
        }
    }
    impl<T: WrappingSub> WrappingSub for Wrapping<T> where Wrapping<T>: Sub<Output = Wrapping<T>> {
        fn wrapping_sub(&self, v: &Self) -> Self {
            Wrapping(self.0.wrapping_sub(&v.0))
        }
    }
    impl<T: WrappingMul> WrappingMul for Wrapping<T> where Wrapping<T>: Mul<Output = Wrapping<T>> {
        fn wrapping_mul(&self, v: &Self) -> Self {
            Wrapping(self.0.wrapping_mul(&v.0))
        }
    }

    #[test]
    fn test_wrapping_traits() {
        fn wrapping_add<T: WrappingAdd>(a: T, b: T) -> T { a.wrapping_add(&b) }
        fn wrapping_sub<T: WrappingSub>(a: T, b: T) -> T { a.wrapping_sub(&b) }
        fn wrapping_mul<T: WrappingMul>(a: T, b: T) -> T { a.wrapping_mul(&b) }
        assert_eq!(wrapping_add(255, 1), 0u8);
        assert_eq!(wrapping_sub(0, 1), 255u8);
        assert_eq!(wrapping_mul(255, 2), 254u8);
        assert_eq!(wrapping_add(255, 1), (Wrapping(255u8) + Wrapping(1u8)).0);
        assert_eq!(wrapping_sub(0, 1), (Wrapping(0u8) - Wrapping(1u8)).0);
        assert_eq!(wrapping_mul(255, 2), (Wrapping(255u8) * Wrapping(2u8)).0);
    }

    #[test]
    fn wrapping_is_wrappingadd() {
        fn require_wrappingadd<T: WrappingAdd>(_: &T) {}
        require_wrappingadd(&Wrapping(42));
    }

    #[test]
    fn wrapping_is_wrappingsub() {
        fn require_wrappingsub<T: WrappingSub>(_: &T) {}
        require_wrappingsub(&Wrapping(42));
    }

    #[test]
    fn wrapping_is_wrappingmul() {
        fn require_wrappingmul<T: WrappingMul>(_: &T) {}
        require_wrappingmul(&Wrapping(42));
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)