intx 0.1.0

Defines new integer types with non-standard but fixed sizes.
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
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203

pub use crate::{
    I104, I112, I120, I128, I16, I24, I32, I40, I48, I56, I64, I72, I80, I88, I96, U104, U112,
    U120, U128, U16, U24, U32, U40, U48, U56, U64, U72, U80, U88, U96,
};

/// Convenience trait implemented by primitive integers to streamline
/// `TryFrom` implementations for non-standard bitwidth integers like `I24`
/// or `U48`.
pub(crate) trait IsWithinBoundsOf<T> {
    /// Returns `true` if the value of `self` is within bounds for type `T`.
    #[allow(clippy::wrong_self_convention)] // Note: we only implement this for Rust built-in integer types.
    fn is_within_bounds(self) -> bool;
}

macro_rules! impl_is_within_bounds_of_for {
    ( $( impl IsWithinBoundsOf<$of:ty> for $for:ty as $mode:ident );* $(;)? ) => {
        $(
            impl_is_within_bounds_of_for!(
                @impl IsWithinBoundsOf<$of> for $for as $mode
            );
        )*
    };
    ( @impl IsWithinBoundsOf<$of:ty> for $for:ty as u2u ) => {
        impl $crate::within_bounds::IsWithinBoundsOf<$of> for $for {
            #[inline]
            fn is_within_bounds(self) -> ::core::primitive::bool {
                self < (1 << <$of>::BITS)
            }
        }
    };
    ( @impl IsWithinBoundsOf<$of:ty> for $for:ty as i2u ) => {
        impl $crate::within_bounds::IsWithinBoundsOf<$of> for $for {
            #[inline]
            fn is_within_bounds(self) -> ::core::primitive::bool {
                self < (1 << (<$of>::BITS - 1))
            }
        }
    };
    ( @impl IsWithinBoundsOf<$of:ty> for $for:ty as u2i ) => {
        impl $crate::within_bounds::IsWithinBoundsOf<$of> for $for {
            #[inline]
            fn is_within_bounds(self) -> ::core::primitive::bool {
                !self.is_negative() && self < (1 << <$of>::BITS)
            }
        }
    };
    ( @impl IsWithinBoundsOf<$of:ty> for $for:ty as isNonNegative ) => {
        // Case: Needed when converting from a smaller signed integer
        // primitive to a larger unsigned unaligned integer.
        //
        // These conversions are valid as long as the source value
        // is non-negative.
        //
        // # Example
        //
        // - `impl TryFrom<i8> for U24`
        impl $crate::within_bounds::IsWithinBoundsOf<$of> for $for {
            #[inline]
            fn is_within_bounds(self) -> ::core::primitive::bool {
                !self.is_negative()
            }
        }
    };
    ( @impl IsWithinBoundsOf<$of:ty> for $for:ty as i2i ) => {
        impl $crate::within_bounds::IsWithinBoundsOf<$of> for $for {
            #[inline]
            fn is_within_bounds(self) -> ::core::primitive::bool {
                let upper_bound = 1 << (<$of>::BITS - 1);
                let lower_bound = -upper_bound;
                lower_bound <= self && self < upper_bound
            }
        }
    };
}
impl_is_within_bounds_of_for! {
    impl IsWithinBoundsOf<U16> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U24> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U32> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U40> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U48> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U56> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U64> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U72> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U80> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U88> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U96> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U104> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U112> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U120> for i8 as isNonNegative;
    impl IsWithinBoundsOf<U128> for i8 as isNonNegative;

    impl IsWithinBoundsOf<U16> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U24> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U32> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U40> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U48> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U56> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U64> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U72> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U80> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U88> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U96> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U104> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U112> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U120> for i16 as isNonNegative;
    impl IsWithinBoundsOf<U128> for i16 as isNonNegative;

    impl IsWithinBoundsOf<U24> for u32 as u2u;
    impl IsWithinBoundsOf<I24> for u32 as i2u;

    impl IsWithinBoundsOf<U16> for i32 as u2i;
    impl IsWithinBoundsOf<U24> for i32 as u2i;
    impl IsWithinBoundsOf<I24> for i32 as i2i;
    impl IsWithinBoundsOf<U32> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U40> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U48> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U56> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U64> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U72> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U80> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U88> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U96> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U104> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U112> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U120> for i32 as isNonNegative;
    impl IsWithinBoundsOf<U128> for i32 as isNonNegative;

    impl IsWithinBoundsOf<U24> for u64 as u2u;
    impl IsWithinBoundsOf<I24> for u64 as i2u;
    impl IsWithinBoundsOf<U40> for u64 as u2u;
    impl IsWithinBoundsOf<I40> for u64 as i2u;
    impl IsWithinBoundsOf<U48> for u64 as u2u;
    impl IsWithinBoundsOf<I48> for u64 as i2u;
    impl IsWithinBoundsOf<U56> for u64 as u2u;
    impl IsWithinBoundsOf<I56> for u64 as i2u;

    impl IsWithinBoundsOf<U16> for i64 as u2i;
    impl IsWithinBoundsOf<U24> for i64 as u2i;
    impl IsWithinBoundsOf<I24> for i64 as i2i;
    impl IsWithinBoundsOf<U32> for i64 as u2i;
    impl IsWithinBoundsOf<U40> for i64 as u2i;
    impl IsWithinBoundsOf<I40> for i64 as i2i;
    impl IsWithinBoundsOf<U48> for i64 as u2i;
    impl IsWithinBoundsOf<I48> for i64 as i2i;
    impl IsWithinBoundsOf<U56> for i64 as u2i;
    impl IsWithinBoundsOf<I56> for i64 as i2i;
    impl IsWithinBoundsOf<U64> for i64 as isNonNegative;
    impl IsWithinBoundsOf<U72> for i64 as isNonNegative;
    impl IsWithinBoundsOf<U80> for i64 as isNonNegative;
    impl IsWithinBoundsOf<U88> for i64 as isNonNegative;
    impl IsWithinBoundsOf<U96> for i64 as isNonNegative;
    impl IsWithinBoundsOf<U104> for i64 as isNonNegative;
    impl IsWithinBoundsOf<U112> for i64 as isNonNegative;
    impl IsWithinBoundsOf<U120> for i64 as isNonNegative;
    impl IsWithinBoundsOf<U128> for i64 as isNonNegative;

    impl IsWithinBoundsOf<U24> for u128 as u2u;
    impl IsWithinBoundsOf<I24> for u128 as i2u;
    impl IsWithinBoundsOf<U40> for u128 as u2u;
    impl IsWithinBoundsOf<I40> for u128 as i2u;
    impl IsWithinBoundsOf<U48> for u128 as u2u;
    impl IsWithinBoundsOf<I48> for u128 as i2u;
    impl IsWithinBoundsOf<U56> for u128 as u2u;
    impl IsWithinBoundsOf<I56> for u128 as i2u;
    impl IsWithinBoundsOf<U72> for u128 as u2u;
    impl IsWithinBoundsOf<I72> for u128 as i2u;
    impl IsWithinBoundsOf<U80> for u128 as u2u;
    impl IsWithinBoundsOf<I80> for u128 as i2u;
    impl IsWithinBoundsOf<U88> for u128 as u2u;
    impl IsWithinBoundsOf<I88> for u128 as i2u;
    impl IsWithinBoundsOf<U96> for u128 as u2u;
    impl IsWithinBoundsOf<I96> for u128 as i2u;
    impl IsWithinBoundsOf<U104> for u128 as u2u;
    impl IsWithinBoundsOf<I104> for u128 as i2u;
    impl IsWithinBoundsOf<U112> for u128 as u2u;
    impl IsWithinBoundsOf<I112> for u128 as i2u;
    impl IsWithinBoundsOf<U120> for u128 as u2u;
    impl IsWithinBoundsOf<I120> for u128 as i2u;

    impl IsWithinBoundsOf<U24> for i128 as u2i;
    impl IsWithinBoundsOf<I24> for i128 as i2i;
    impl IsWithinBoundsOf<U40> for i128 as u2i;
    impl IsWithinBoundsOf<I40> for i128 as i2i;
    impl IsWithinBoundsOf<U48> for i128 as u2i;
    impl IsWithinBoundsOf<I48> for i128 as i2i;
    impl IsWithinBoundsOf<U56> for i128 as u2i;
    impl IsWithinBoundsOf<I56> for i128 as i2i;
    impl IsWithinBoundsOf<U72> for i128 as u2i;
    impl IsWithinBoundsOf<I72> for i128 as i2i;
    impl IsWithinBoundsOf<U80> for i128 as u2i;
    impl IsWithinBoundsOf<I80> for i128 as i2i;
    impl IsWithinBoundsOf<U88> for i128 as u2i;
    impl IsWithinBoundsOf<I88> for i128 as i2i;
    impl IsWithinBoundsOf<U96> for i128 as u2i;
    impl IsWithinBoundsOf<I96> for i128 as i2i;
    impl IsWithinBoundsOf<U104> for i128 as u2i;
    impl IsWithinBoundsOf<I104> for i128 as i2i;
    impl IsWithinBoundsOf<U112> for i128 as u2i;
    impl IsWithinBoundsOf<I112> for i128 as i2i;
    impl IsWithinBoundsOf<U120> for i128 as u2i;
    impl IsWithinBoundsOf<U128> for i128 as isNonNegative;
    impl IsWithinBoundsOf<I120> for i128 as i2i;
}