satint 0.2.2

Saturating integer scalar wrappers for no_std Rust
Documentation 
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

//! Unsigned saturating scalar aliases and constructors.

use crate::{define_wrapper, scalars};

define_wrapper!(Su);

scalars! {
    Su, Su8, su8, u8;
    Su, Su16, su16, u16;
    Su, Su32, su32, u32;
    Su, Su64, su64, u64;
    Su, Su128, su128, u128;
}

macro_rules! unsigned_scalar_methods {
    ($($alias:ident, $ctor:ident);+ $(;)?) => {
        $(
            impl $alias {
                /// Computes the absolute difference between `self` and `rhs`.
                #[inline]
                #[must_use]
                pub const fn abs_diff(self, rhs: Self) -> Self {
                    $ctor(self.into_inner().abs_diff(rhs.into_inner()))
                }

                /// Returns `true` if `self` is a power of two.
                #[inline]
                #[must_use]
                pub const fn is_power_of_two(self) -> bool {
                    self.into_inner().is_power_of_two()
                }

                /// Returns the smallest power of two greater than or equal to `self`,
                /// saturating at `MAX` if the primitive operation would overflow.
                #[inline]
                #[must_use]
                pub const fn next_power_of_two(self) -> Self {
                    match self.checked_next_power_of_two() {
                        Some(v) => v,
                        None => Self::MAX,
                    }
                }

                /// Returns the smallest power of two greater than or equal to `self`,
                /// or `None` if the primitive operation would overflow.
                #[inline]
                #[must_use]
                pub const fn checked_next_power_of_two(self) -> Option<Self> {
                    match self.into_inner().checked_next_power_of_two() {
                        Some(v) => Some($ctor(v)),
                        None => None,
                    }
                }

                /// Returns the integer square root.
                #[inline]
                #[must_use]
                pub const fn isqrt(self) -> Self {
                    $ctor(self.into_inner().isqrt())
                }
            }
        )+
    };
}

unsigned_scalar_methods! {
    Su8, su8;
    Su16, su16;
    Su32, su32;
    Su64, su64;
    Su128, su128;
}