nsw_types/
lib.rs

1//! # nsw-types - non-standard-width integers types
2//!
3//! When non-standard-width integers is required in an applications, the norm is to use a larger container and make sure the value is within range after manipulation. nsw-types aims to take care of this once and for all by:
4//!
5//! - Providing `u1`-`u127` and `i1`-`i127` types that should behave as similar as possible to the built in rust types
6//!     - The methods of the defined types are the same as for the built in types (far from all is implemented at this point but fill out an issue or create a PR if something essential for you is missing)
7//!     - Overflow will panic in debug and wrap in release.
8//! - All possible infallible conversions is possible by using `From` and all fallible conversion by using `TryFrom`.
9//!
10//! The types take up as much space as the smallest integer type that can contain them;
11//! the compiler can not yet be made aware of further optimization potential,
12//! and thus does not use it:
13//! an `Option<u7>` still takes up two bytes.
14
15#![cfg_attr(not(feature = "std"), no_std)]
16
17mod lib {
18    pub use core;
19}
20
21mod conversion;
22#[cfg(feature = "num-traits")]
23pub mod num_traits_impls;
24pub mod trait_impls;
25#[cfg(feature = "num-traits")]
26pub use num_traits;
27
28use lib::core::ops::{
29    BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Not, Shl, ShlAssign, Shr,
30    ShrAssign,
31};
32
33use lib::core::fmt::{Binary, Display, Formatter, LowerHex, Octal, UpperHex};
34
35macro_rules! define_unsigned {
36    ($name:ident, $bits:expr, $type:ident) => {define_unsigned!(#[doc=""], $name, $bits, $type);};
37    (#[$doc:meta], $name:ident, $bits:expr, $type:ident) => {
38
39       #[$doc]
40        #[allow(non_camel_case_types)]
41        #[derive(Default, Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
42        pub struct $name($type);
43
44        impl $name {
45            pub const MAX: Self = $name(((1 as $type) << $bits) -1 );
46            pub const MIN: Self = $name(0);
47            pub const BITS: u32 = $bits;
48
49            fn mask(self) -> Self {
50                $name(self.0 & ( ((1 as $type) << $bits).overflowing_sub(1).0))
51            }
52        }
53
54        implement_common!($name, $bits, $type);
55
56    }
57}
58
59macro_rules! define_signed {
60    ($name:ident, $bits:expr, $type:ident) => {define_signed!(#[doc=""], $name, $bits, $type);};
61    (#[$doc:meta], $name:ident, $bits:expr, $type:ident) => {
62
63        #[$doc]
64        #[allow(non_camel_case_types)]
65        #[derive(Default, Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
66        pub struct $name($type);
67
68        #[$doc]
69        impl $name {
70            pub const MAX: Self = $name(((1 as $type) << ($bits - 1)) - 1);
71            pub const MIN: Self = $name(-((1 as $type) << ($bits - 1)));
72            pub const BITS: u32 = $bits;
73
74            fn mask(self) -> Self {
75                if ( self.0 & (1<<($bits-1)) ) == 0 {
76                    $name(self.0 & ( ((1 as $type) << $bits).overflowing_sub(1).0))
77                } else {
78                    $name(self.0 | !( ((1 as $type) << $bits).overflowing_sub(1).0))
79                }
80            }
81        }
82
83        implement_common!($name, $bits, $type);
84
85    }
86}
87
88macro_rules! implement_common {
89    ($name:ident, $bits:expr, $type:ident) => {
90        impl $name {
91            /// Returns the smallest value that can be represented by this integer type.
92            pub fn min_value() -> $name {
93                $name::MIN
94            }
95            /// Returns the largest value that can be represented by this integer type.
96            pub fn max_value() -> $name {
97                $name::MAX
98            }
99
100            /// Crates a new variable
101            ///
102            /// This function mainly exists as there is currently not a better way to construct these types.
103            /// May be deprecated or removed if a better way to construct these types becomes available.
104            ///
105            /// # Examples
106            ///
107            /// Basic usage:
108            ///
109            /// ```
110            /// use nsw_types::*;
111            ///
112            /// assert_eq!(u31::new(64), u31::from(64u8));
113            ///
114            /// ```
115            ///
116            /// # Panic
117            ///
118            /// This function will panic if `value` is not representable by this type
119            pub const fn new(value: $type) -> $name {
120                assert!(value <= $name::MAX.0 && value >= $name::MIN.0);
121                $name(value)
122            }
123
124            /// Wrapping (modular) subtraction. Computes `self - other`,
125            /// wrapping around at the boundary of the type.
126            ///
127            /// # Examples
128            ///
129            /// Basic usage:
130            ///
131            /// ```
132            /// use nsw_types::*;
133            ///
134            /// assert_eq!(i5::MIN.wrapping_sub(i5::new(1)), i5::MAX);
135            ///
136            /// assert_eq!(i5::new(-10).wrapping_sub(i5::new(5)), i5::new(-15));
137            /// assert_eq!(i5::new(-15).wrapping_sub(i5::new(5)), i5::new(12));
138            /// ```
139            pub fn wrapping_sub(self, rhs: Self) -> Self {
140                $name(self.0.wrapping_sub(rhs.0)).mask()
141            }
142
143            /// Wrapping (modular) addition. Computes `self + other`,
144            /// wrapping around at the boundary of the type.
145            ///
146            /// # Examples
147            ///
148            /// Basic usage:
149            ///
150            /// ```
151            /// use nsw_types::*;
152            ///
153            /// assert_eq!(i5::MAX.wrapping_add(i5::new(1)), i5::MIN);
154            ///
155            /// assert_eq!(i5::new(10).wrapping_add(i5::new(5)), i5::new(15));
156            /// assert_eq!(i5::new(15).wrapping_add(i5::new(5)), i5::new(-12));
157            /// ```
158            pub fn wrapping_add(self, rhs: Self) -> Self {
159                $name(self.0.wrapping_add(rhs.0)).mask()
160            }
161        }
162
163        // Implement formating functions
164        impl Display for $name {
165            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
166                let $name(ref value) = self;
167                <$type as Display>::fmt(value, f)
168            }
169        }
170        impl UpperHex for $name {
171            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
172                let $name(ref value) = self;
173                <$type as UpperHex>::fmt(value, f)
174            }
175        }
176        impl LowerHex for $name {
177            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
178                let $name(ref value) = self;
179                <$type as LowerHex>::fmt(value, f)
180            }
181        }
182        impl Octal for $name {
183            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
184                let $name(ref value) = self;
185                <$type as Octal>::fmt(value, f)
186            }
187        }
188        impl Binary for $name {
189            fn fmt(&self, f: &mut Formatter) -> Result<(), lib::core::fmt::Error> {
190                let $name(ref value) = self;
191                <$type as Binary>::fmt(value, f)
192            }
193        }
194
195        impl<T> Shr<T> for $name
196        where
197            $type: Shr<T, Output = $type>,
198        {
199            type Output = $name;
200
201            fn shr(self, rhs: T) -> $name {
202                $name(self.0.shr(rhs))
203            }
204        }
205
206        impl<T> Shl<T> for $name
207        where
208            $type: Shl<T, Output = $type>,
209        {
210            type Output = $name;
211
212            fn shl(self, rhs: T) -> $name {
213                $name(self.0.shl(rhs)).mask()
214            }
215        }
216
217        impl<T> ShrAssign<T> for $name
218        where
219            $type: ShrAssign<T>,
220        {
221            fn shr_assign(&mut self, rhs: T) {
222                self.0.shr_assign(rhs);
223            }
224        }
225
226        impl<T> ShlAssign<T> for $name
227        where
228            $type: ShlAssign<T>,
229        {
230            fn shl_assign(&mut self, rhs: T) {
231                self.0.shl_assign(rhs);
232                *self = self.mask();
233            }
234        }
235
236        impl BitOr<$name> for $name {
237            type Output = $name;
238
239            fn bitor(self, rhs: $name) -> Self::Output {
240                $name(self.0.bitor(rhs.0))
241            }
242        }
243
244        impl<'a> BitOr<&'a $name> for $name {
245            type Output = <$name as BitOr<$name>>::Output;
246
247            fn bitor(self, rhs: &'a $name) -> Self::Output {
248                $name(self.0.bitor(rhs.0))
249            }
250        }
251
252        impl<'a> BitOr<$name> for &'a $name {
253            type Output = <$name as BitOr<$name>>::Output;
254
255            fn bitor(self, rhs: $name) -> Self::Output {
256                $name(self.0.bitor(rhs.0))
257            }
258        }
259
260        impl<'a> BitOr<&'a $name> for &'a $name {
261            type Output = <$name as BitOr<$name>>::Output;
262
263            fn bitor(self, rhs: &'a $name) -> Self::Output {
264                $name(self.0.bitor(rhs.0))
265            }
266        }
267
268        impl BitOrAssign<$name> for $name {
269            fn bitor_assign(&mut self, other: $name) {
270                self.0.bitor_assign(other.0)
271            }
272        }
273
274        impl BitXor<$name> for $name {
275            type Output = $name;
276
277            fn bitxor(self, rhs: $name) -> Self::Output {
278                $name(self.0.bitxor(rhs.0))
279            }
280        }
281
282        impl<'a> BitXor<&'a $name> for $name {
283            type Output = <$name as BitOr<$name>>::Output;
284
285            fn bitxor(self, rhs: &'a $name) -> Self::Output {
286                $name(self.0.bitxor(rhs.0))
287            }
288        }
289
290        impl<'a> BitXor<$name> for &'a $name {
291            type Output = <$name as BitOr<$name>>::Output;
292
293            fn bitxor(self, rhs: $name) -> Self::Output {
294                $name(self.0.bitxor(rhs.0))
295            }
296        }
297
298        impl<'a> BitXor<&'a $name> for &'a $name {
299            type Output = <$name as BitOr<$name>>::Output;
300
301            fn bitxor(self, rhs: &'a $name) -> Self::Output {
302                $name(self.0.bitxor(rhs.0))
303            }
304        }
305
306        impl BitXorAssign<$name> for $name {
307            fn bitxor_assign(&mut self, other: $name) {
308                self.0.bitxor_assign(other.0)
309            }
310        }
311
312        impl Not for $name {
313            type Output = $name;
314
315            fn not(self) -> $name {
316                $name(self.0.not()).mask()
317            }
318        }
319
320        impl<'a> Not for &'a $name {
321            type Output = <$name as Not>::Output;
322
323            fn not(self) -> $name {
324                $name(self.0.not()).mask()
325            }
326        }
327
328        impl BitAnd<$name> for $name {
329            type Output = $name;
330
331            fn bitand(self, rhs: $name) -> Self::Output {
332                $name(self.0.bitand(rhs.0))
333            }
334        }
335
336        impl<'a> BitAnd<&'a $name> for $name {
337            type Output = <$name as BitOr<$name>>::Output;
338
339            fn bitand(self, rhs: &'a $name) -> Self::Output {
340                $name(self.0.bitand(rhs.0))
341            }
342        }
343
344        impl<'a> BitAnd<$name> for &'a $name {
345            type Output = <$name as BitOr<$name>>::Output;
346
347            fn bitand(self, rhs: $name) -> Self::Output {
348                $name(self.0.bitand(rhs.0))
349            }
350        }
351
352        impl<'a> BitAnd<&'a $name> for &'a $name {
353            type Output = <$name as BitOr<$name>>::Output;
354
355            fn bitand(self, rhs: &'a $name) -> Self::Output {
356                $name(self.0.bitand(rhs.0))
357            }
358        }
359
360        impl BitAndAssign<$name> for $name {
361            fn bitand_assign(&mut self, other: $name) {
362                self.0.bitand_assign(other.0)
363            }
364        }
365
366        impl lib::core::ops::Add<$name> for $name {
367            type Output = $name;
368            #[allow(unused_comparisons)]
369            fn add(self, other: $name) -> $name {
370                if self.0 > 0 && other.0 > 0 {
371                    debug_assert!(Self::MAX.0 - other.0 >= self.0);
372                } else if self.0 < 0 && other.0 < 0 {
373                    debug_assert!(Self::MIN.0 - other.0 <= self.0);
374                }
375                self.wrapping_add(other)
376            }
377        }
378
379        impl lib::core::ops::Sub<$name> for $name {
380            type Output = $name;
381            #[allow(unused_comparisons)]
382            fn sub(self, other: $name) -> $name {
383                if self > other {
384                    debug_assert!(Self::MAX.0 + other.0 >= self.0);
385                } else if self < other {
386                    debug_assert!(Self::MIN.0 + other.0 <= self.0);
387                }
388                self.wrapping_sub(other)
389            }
390        }
391
392        impl lib::core::ops::Mul<$name> for $name {
393            type Output = $name;
394
395            fn mul(self, rhs: $name) -> Self::Output {
396                match self.0 * rhs.0 {
397                    v if v > Self::MAX.0 => panic!("attempt to multiply with overflow"),
398                    v => $name(v).mask(),
399                }
400            }
401        }
402    };
403}
404
405define_unsigned!(#[doc="The 1-bit unsigned integer type."], u1, 1, u8);
406define_unsigned!(#[doc="The 2-bit unsigned integer type."], u2, 2, u8);
407define_unsigned!(#[doc="The 3-bit unsigned integer type."], u3, 3, u8);
408define_unsigned!(#[doc="The 4-bit unsigned integer type."], u4, 4, u8);
409define_unsigned!(#[doc="The 5-bit unsigned integer type."], u5, 5, u8);
410define_unsigned!(#[doc="The 6-bit unsigned integer type."], u6, 6, u8);
411define_unsigned!(#[doc="The 7-bit unsigned integer type."], u7, 7, u8);
412
413define_unsigned!(#[doc="The 9-bit unsigned integer type."], u9, 9, u16);
414define_unsigned!(#[doc="The 10-bit unsigned integer type."], u10, 10, u16);
415define_unsigned!(#[doc="The 11-bit unsigned integer type."], u11, 11, u16);
416define_unsigned!(#[doc="The 12-bit unsigned integer type."], u12, 12, u16);
417define_unsigned!(#[doc="The 13-bit unsigned integer type."], u13, 13, u16);
418define_unsigned!(#[doc="The 14-bit unsigned integer type."], u14, 14, u16);
419define_unsigned!(#[doc="The 15-bit unsigned integer type."], u15, 15, u16);
420
421define_unsigned!(#[doc="The 17-bit unsigned integer type."], u17, 17, u32);
422define_unsigned!(#[doc="The 18-bit unsigned integer type."], u18, 18, u32);
423define_unsigned!(#[doc="The 19-bit unsigned integer type."], u19, 19, u32);
424define_unsigned!(#[doc="The 20-bit unsigned integer type."], u20, 20, u32);
425define_unsigned!(#[doc="The 21-bit unsigned integer type."], u21, 21, u32);
426define_unsigned!(#[doc="The 22-bit unsigned integer type."], u22, 22, u32);
427define_unsigned!(#[doc="The 23-bit unsigned integer type."], u23, 23, u32);
428define_unsigned!(#[doc="The 24-bit unsigned integer type."], u24, 24, u32);
429
430define_unsigned!(#[doc="The 25-bit unsigned integer type."], u25, 25, u32);
431define_unsigned!(#[doc="The 26-bit unsigned integer type."], u26, 26, u32);
432define_unsigned!(#[doc="The 27-bit unsigned integer type."], u27, 27, u32);
433define_unsigned!(#[doc="The 28-bit unsigned integer type."], u28, 28, u32);
434define_unsigned!(#[doc="The 29-bit unsigned integer type."], u29, 29, u32);
435define_unsigned!(#[doc="The 30-bit unsigned integer type."], u30, 30, u32);
436define_unsigned!(#[doc="The 31-bit unsigned integer type."], u31, 31, u32);
437
438define_unsigned!(#[doc="The 33-bit unsigned integer type."], u33, 33, u64);
439define_unsigned!(#[doc="The 34-bit unsigned integer type."], u34, 34, u64);
440define_unsigned!(#[doc="The 35-bit unsigned integer type."], u35, 35, u64);
441define_unsigned!(#[doc="The 36-bit unsigned integer type."], u36, 36, u64);
442define_unsigned!(#[doc="The 37-bit unsigned integer type."], u37, 37, u64);
443define_unsigned!(#[doc="The 38-bit unsigned integer type."], u38, 38, u64);
444define_unsigned!(#[doc="The 39-bit unsigned integer type."], u39, 39, u64);
445define_unsigned!(#[doc="The 40-bit unsigned integer type."], u40, 40, u64);
446
447define_unsigned!(#[doc="The 41-bit unsigned integer type."], u41, 41, u64);
448define_unsigned!(#[doc="The 42-bit unsigned integer type."], u42, 42, u64);
449define_unsigned!(#[doc="The 43-bit unsigned integer type."], u43, 43, u64);
450define_unsigned!(#[doc="The 44-bit unsigned integer type."], u44, 44, u64);
451define_unsigned!(#[doc="The 45-bit unsigned integer type."], u45, 45, u64);
452define_unsigned!(#[doc="The 46-bit unsigned integer type."], u46, 46, u64);
453define_unsigned!(#[doc="The 47-bit unsigned integer type."], u47, 47, u64);
454define_unsigned!(#[doc="The 48-bit unsigned integer type."], u48, 48, u64);
455
456define_unsigned!(#[doc="The 49-bit unsigned integer type."], u49, 49, u64);
457define_unsigned!(#[doc="The 50-bit unsigned integer type."], u50, 50, u64);
458define_unsigned!(#[doc="The 51-bit unsigned integer type."], u51, 51, u64);
459define_unsigned!(#[doc="The 52-bit unsigned integer type."], u52, 52, u64);
460define_unsigned!(#[doc="The 53-bit unsigned integer type."], u53, 53, u64);
461define_unsigned!(#[doc="The 54-bit unsigned integer type."], u54, 54, u64);
462define_unsigned!(#[doc="The 55-bit unsigned integer type."], u55, 55, u64);
463define_unsigned!(#[doc="The 56-bit unsigned integer type."], u56, 56, u64);
464
465define_unsigned!(#[doc="The 57-bit unsigned integer type."], u57, 57, u64);
466define_unsigned!(#[doc="The 58-bit unsigned integer type."], u58, 58, u64);
467define_unsigned!(#[doc="The 59-bit unsigned integer type."], u59, 59, u64);
468define_unsigned!(#[doc="The 60-bit unsigned integer type."], u60, 60, u64);
469define_unsigned!(#[doc="The 61-bit unsigned integer type."], u61, 61, u64);
470define_unsigned!(#[doc="The 62-bit unsigned integer type."], u62, 62, u64);
471define_unsigned!(#[doc="The 63-bit unsigned integer type."], u63, 63, u64);
472
473define_unsigned!(#[doc="The 65-bit unsigned integer type."], u65, 65, u128);
474define_unsigned!(#[doc="The 66-bit unsigned integer type."], u66, 66, u128);
475define_unsigned!(#[doc="The 67-bit unsigned integer type."], u67, 67, u128);
476define_unsigned!(#[doc="The 68-bit unsigned integer type."], u68, 68, u128);
477define_unsigned!(#[doc="The 69-bit unsigned integer type."], u69, 69, u128);
478define_unsigned!(#[doc="The 70-bit unsigned integer type."], u70, 70, u128);
479define_unsigned!(#[doc="The 71-bit unsigned integer type."], u71, 71, u128);
480define_unsigned!(#[doc="The 72-bit unsigned integer type."], u72, 72, u128);
481
482define_unsigned!(#[doc="The 73-bit unsigned integer type."], u73, 73, u128);
483define_unsigned!(#[doc="The 74-bit unsigned integer type."], u74, 74, u128);
484define_unsigned!(#[doc="The 75-bit unsigned integer type."], u75, 75, u128);
485define_unsigned!(#[doc="The 76-bit unsigned integer type."], u76, 76, u128);
486define_unsigned!(#[doc="The 77-bit unsigned integer type."], u77, 77, u128);
487define_unsigned!(#[doc="The 78-bit unsigned integer type."], u78, 78, u128);
488define_unsigned!(#[doc="The 79-bit unsigned integer type."], u79, 79, u128);
489define_unsigned!(#[doc="The 80-bit unsigned integer type."], u80, 80, u128);
490
491define_unsigned!(#[doc="The 81-bit unsigned integer type."], u81, 81, u128);
492define_unsigned!(#[doc="The 82-bit unsigned integer type."], u82, 82, u128);
493define_unsigned!(#[doc="The 83-bit unsigned integer type."], u83, 83, u128);
494define_unsigned!(#[doc="The 84-bit unsigned integer type."], u84, 84, u128);
495define_unsigned!(#[doc="The 85-bit unsigned integer type."], u85, 85, u128);
496define_unsigned!(#[doc="The 86-bit unsigned integer type."], u86, 86, u128);
497define_unsigned!(#[doc="The 87-bit unsigned integer type."], u87, 87, u128);
498define_unsigned!(#[doc="The 88-bit unsigned integer type."], u88, 88, u128);
499
500define_unsigned!(#[doc="The 89-bit unsigned integer type."], u89, 89, u128);
501define_unsigned!(#[doc="The 90-bit unsigned integer type."], u90, 90, u128);
502define_unsigned!(#[doc="The 91-bit unsigned integer type."], u91, 91, u128);
503define_unsigned!(#[doc="The 92-bit unsigned integer type."], u92, 92, u128);
504define_unsigned!(#[doc="The 93-bit unsigned integer type."], u93, 93, u128);
505define_unsigned!(#[doc="The 94-bit unsigned integer type."], u94, 94, u128);
506define_unsigned!(#[doc="The 95-bit unsigned integer type."], u95, 95, u128);
507define_unsigned!(#[doc="The 96-bit unsigned integer type."], u96, 96, u128);
508
509define_unsigned!(#[doc="The 97-bit unsigned integer type."], u97, 97, u128);
510define_unsigned!(#[doc="The 98-bit unsigned integer type."], u98, 98, u128);
511define_unsigned!(#[doc="The 99-bit unsigned integer type."], u99, 99, u128);
512define_unsigned!(#[doc="The 100-bit unsigned integer type."], u100, 100, u128);
513define_unsigned!(#[doc="The 101-bit unsigned integer type."], u101, 101, u128);
514define_unsigned!(#[doc="The 102-bit unsigned integer type."], u102, 102, u128);
515define_unsigned!(#[doc="The 103-bit unsigned integer type."], u103, 103, u128);
516define_unsigned!(#[doc="The 104-bit unsigned integer type."], u104, 104, u128);
517
518define_unsigned!(#[doc="The 105-bit unsigned integer type."], u105, 105, u128);
519define_unsigned!(#[doc="The 106-bit unsigned integer type."], u106, 106, u128);
520define_unsigned!(#[doc="The 107-bit unsigned integer type."], u107, 107, u128);
521define_unsigned!(#[doc="The 108-bit unsigned integer type."], u108, 108, u128);
522define_unsigned!(#[doc="The 109-bit unsigned integer type."], u109, 109, u128);
523define_unsigned!(#[doc="The 110-bit unsigned integer type."], u110, 110, u128);
524define_unsigned!(#[doc="The 111-bit unsigned integer type."], u111, 111, u128);
525define_unsigned!(#[doc="The 112-bit unsigned integer type."], u112, 112, u128);
526
527define_unsigned!(#[doc="The 113-bit unsigned integer type."], u113, 113, u128);
528define_unsigned!(#[doc="The 114-bit unsigned integer type."], u114, 114, u128);
529define_unsigned!(#[doc="The 115-bit unsigned integer type."], u115, 115, u128);
530define_unsigned!(#[doc="The 116-bit unsigned integer type."], u116, 116, u128);
531define_unsigned!(#[doc="The 117-bit unsigned integer type."], u117, 117, u128);
532define_unsigned!(#[doc="The 118-bit unsigned integer type."], u118, 118, u128);
533define_unsigned!(#[doc="The 119-bit unsigned integer type."], u119, 119, u128);
534define_unsigned!(#[doc="The 120-bit unsigned integer type."], u120, 120, u128);
535
536define_unsigned!(#[doc="The 121-bit unsigned integer type."], u121, 121, u128);
537define_unsigned!(#[doc="The 122-bit unsigned integer type."], u122, 122, u128);
538define_unsigned!(#[doc="The 123-bit unsigned integer type."], u123, 123, u128);
539define_unsigned!(#[doc="The 124-bit unsigned integer type."], u124, 124, u128);
540define_unsigned!(#[doc="The 125-bit unsigned integer type."], u125, 125, u128);
541define_unsigned!(#[doc="The 126-bit unsigned integer type."], u126, 126, u128);
542define_unsigned!(#[doc="The 127-bit unsigned integer type."], u127, 127, u128);
543
544define_signed!(#[doc="The 1-bit signed integer type."], i1, 1, i8);
545define_signed!(#[doc="The 2-bit signed integer type."], i2, 2, i8);
546define_signed!(#[doc="The 3-bit signed integer type."], i3, 3, i8);
547define_signed!(#[doc="The 4-bit signed integer type."], i4, 4, i8);
548define_signed!(#[doc="The 5-bit signed integer type."], i5, 5, i8);
549define_signed!(#[doc="The 6-bit signed integer type."], i6, 6, i8);
550define_signed!(#[doc="The 7-bit signed integer type."], i7, 7, i8);
551
552define_signed!(#[doc="The 9-bit signed integer type."], i9, 9, i16);
553define_signed!(#[doc="The 10-bit signed integer type."], i10, 10, i16);
554define_signed!(#[doc="The 11-bit signed integer type."], i11, 11, i16);
555define_signed!(#[doc="The 12-bit signed integer type."], i12, 12, i16);
556define_signed!(#[doc="The 13-bit signed integer type."], i13, 13, i16);
557define_signed!(#[doc="The 14-bit signed integer type."], i14, 14, i16);
558define_signed!(#[doc="The 15-bit signed integer type."], i15, 15, i16);
559
560define_signed!(#[doc="The 17-bit signed integer type."], i17, 17, i32);
561define_signed!(#[doc="The 18-bit signed integer type."], i18, 18, i32);
562define_signed!(#[doc="The 19-bit signed integer type."], i19, 19, i32);
563define_signed!(#[doc="The 20-bit signed integer type."], i20, 20, i32);
564define_signed!(#[doc="The 21-bit signed integer type."], i21, 21, i32);
565define_signed!(#[doc="The 22-bit signed integer type."], i22, 22, i32);
566define_signed!(#[doc="The 23-bit signed integer type."], i23, 23, i32);
567define_signed!(#[doc="The 24-bit signed integer type."], i24, 24, i32);
568
569define_signed!(#[doc="The 25-bit signed integer type."], i25, 25, i32);
570define_signed!(#[doc="The 26-bit signed integer type."], i26, 26, i32);
571define_signed!(#[doc="The 27-bit signed integer type."], i27, 27, i32);
572define_signed!(#[doc="The 28-bit signed integer type."], i28, 28, i32);
573define_signed!(#[doc="The 29-bit signed integer type."], i29, 29, i32);
574define_signed!(#[doc="The 30-bit signed integer type."], i30, 30, i32);
575define_signed!(#[doc="The 31-bit signed integer type."], i31, 31, i32);
576
577define_signed!(#[doc="The 33-bit signed integer type."], i33, 33, i64);
578define_signed!(#[doc="The 34-bit signed integer type."], i34, 34, i64);
579define_signed!(#[doc="The 35-bit signed integer type."], i35, 35, i64);
580define_signed!(#[doc="The 36-bit signed integer type."], i36, 36, i64);
581define_signed!(#[doc="The 37-bit signed integer type."], i37, 37, i64);
582define_signed!(#[doc="The 38-bit signed integer type."], i38, 38, i64);
583define_signed!(#[doc="The 39-bit signed integer type."], i39, 39, i64);
584define_signed!(#[doc="The 40-bit signed integer type."], i40, 40, i64);
585
586define_signed!(#[doc="The 41-bit signed integer type."], i41, 41, i64);
587define_signed!(#[doc="The 42-bit signed integer type."], i42, 42, i64);
588define_signed!(#[doc="The 43-bit signed integer type."], i43, 43, i64);
589define_signed!(#[doc="The 44-bit signed integer type."], i44, 44, i64);
590define_signed!(#[doc="The 45-bit signed integer type."], i45, 45, i64);
591define_signed!(#[doc="The 46-bit signed integer type."], i46, 46, i64);
592define_signed!(#[doc="The 47-bit signed integer type."], i47, 47, i64);
593define_signed!(#[doc="The 48-bit signed integer type."], i48, 48, i64);
594
595define_signed!(#[doc="The 49-bit signed integer type."], i49, 49, i64);
596define_signed!(#[doc="The 50-bit signed integer type."], i50, 50, i64);
597define_signed!(#[doc="The 51-bit signed integer type."], i51, 51, i64);
598define_signed!(#[doc="The 52-bit signed integer type."], i52, 52, i64);
599define_signed!(#[doc="The 53-bit signed integer type."], i53, 53, i64);
600define_signed!(#[doc="The 54-bit signed integer type."], i54, 54, i64);
601define_signed!(#[doc="The 55-bit signed integer type."], i55, 55, i64);
602define_signed!(#[doc="The 56-bit signed integer type."], i56, 56, i64);
603
604define_signed!(#[doc="The 57-bit signed integer type."], i57, 57, i64);
605define_signed!(#[doc="The 58-bit signed integer type."], i58, 58, i64);
606define_signed!(#[doc="The 59-bit signed integer type."], i59, 59, i64);
607define_signed!(#[doc="The 60-bit signed integer type."], i60, 60, i64);
608define_signed!(#[doc="The 61-bit signed integer type."], i61, 61, i64);
609define_signed!(#[doc="The 62-bit signed integer type."], i62, 62, i64);
610define_signed!(#[doc="The 63-bit signed integer type."], i63, 63, i64);
611
612define_signed!(#[doc="The 65-bit signed integer type."], i65, 65, i128);
613define_signed!(#[doc="The 66-bit signed integer type."], i66, 66, i128);
614define_signed!(#[doc="The 67-bit signed integer type."], i67, 67, i128);
615define_signed!(#[doc="The 68-bit signed integer type."], i68, 68, i128);
616define_signed!(#[doc="The 69-bit signed integer type."], i69, 69, i128);
617define_signed!(#[doc="The 70-bit signed integer type."], i70, 70, i128);
618define_signed!(#[doc="The 71-bit signed integer type."], i71, 71, i128);
619define_signed!(#[doc="The 72-bit signed integer type."], i72, 72, i128);
620
621define_signed!(#[doc="The 73-bit signed integer type."], i73, 73, i128);
622define_signed!(#[doc="The 74-bit signed integer type."], i74, 74, i128);
623define_signed!(#[doc="The 75-bit signed integer type."], i75, 75, i128);
624define_signed!(#[doc="The 76-bit signed integer type."], i76, 76, i128);
625define_signed!(#[doc="The 77-bit signed integer type."], i77, 77, i128);
626define_signed!(#[doc="The 78-bit signed integer type."], i78, 78, i128);
627define_signed!(#[doc="The 79-bit signed integer type."], i79, 79, i128);
628define_signed!(#[doc="The 80-bit signed integer type."], i80, 80, i128);
629
630define_signed!(#[doc="The 81-bit signed integer type."], i81, 81, i128);
631define_signed!(#[doc="The 82-bit signed integer type."], i82, 82, i128);
632define_signed!(#[doc="The 83-bit signed integer type."], i83, 83, i128);
633define_signed!(#[doc="The 84-bit signed integer type."], i84, 84, i128);
634define_signed!(#[doc="The 85-bit signed integer type."], i85, 85, i128);
635define_signed!(#[doc="The 86-bit signed integer type."], i86, 86, i128);
636define_signed!(#[doc="The 87-bit signed integer type."], i87, 87, i128);
637define_signed!(#[doc="The 88-bit signed integer type."], i88, 88, i128);
638
639define_signed!(#[doc="The 89-bit signed integer type."], i89, 89, i128);
640define_signed!(#[doc="The 90-bit signed integer type."], i90, 90, i128);
641define_signed!(#[doc="The 91-bit signed integer type."], i91, 91, i128);
642define_signed!(#[doc="The 92-bit signed integer type."], i92, 92, i128);
643define_signed!(#[doc="The 93-bit signed integer type."], i93, 93, i128);
644define_signed!(#[doc="The 94-bit signed integer type."], i94, 94, i128);
645define_signed!(#[doc="The 95-bit signed integer type."], i95, 95, i128);
646define_signed!(#[doc="The 96-bit signed integer type."], i96, 96, i128);
647
648define_signed!(#[doc="The 97-bit signed integer type."], i97, 97, i128);
649define_signed!(#[doc="The 98-bit signed integer type."], i98, 98, i128);
650define_signed!(#[doc="The 99-bit signed integer type."], i99, 99, i128);
651define_signed!(#[doc="The 100-bit signed integer type."], i100, 100, i128);
652define_signed!(#[doc="The 101-bit signed integer type."], i101, 101, i128);
653define_signed!(#[doc="The 102-bit signed integer type."], i102, 102, i128);
654define_signed!(#[doc="The 103-bit signed integer type."], i103, 103, i128);
655define_signed!(#[doc="The 104-bit signed integer type."], i104, 104, i128);
656
657define_signed!(#[doc="The 105-bit signed integer type."], i105, 105, i128);
658define_signed!(#[doc="The 106-bit signed integer type."], i106, 106, i128);
659define_signed!(#[doc="The 107-bit signed integer type."], i107, 107, i128);
660define_signed!(#[doc="The 108-bit signed integer type."], i108, 108, i128);
661define_signed!(#[doc="The 109-bit signed integer type."], i109, 109, i128);
662define_signed!(#[doc="The 110-bit signed integer type."], i110, 110, i128);
663define_signed!(#[doc="The 111-bit signed integer type."], i111, 111, i128);
664define_signed!(#[doc="The 112-bit signed integer type."], i112, 112, i128);
665
666define_signed!(#[doc="The 113-bit signed integer type."], i113, 113, i128);
667define_signed!(#[doc="The 114-bit signed integer type."], i114, 114, i128);
668define_signed!(#[doc="The 115-bit signed integer type."], i115, 115, i128);
669define_signed!(#[doc="The 116-bit signed integer type."], i116, 116, i128);
670define_signed!(#[doc="The 117-bit signed integer type."], i117, 117, i128);
671define_signed!(#[doc="The 118-bit signed integer type."], i118, 118, i128);
672define_signed!(#[doc="The 119-bit signed integer type."], i119, 119, i128);
673define_signed!(#[doc="The 120-bit signed integer type."], i120, 120, i128);
674
675define_signed!(#[doc="The 121-bit signed integer type."], i121, 121, i128);
676define_signed!(#[doc="The 122-bit signed integer type."], i122, 122, i128);
677define_signed!(#[doc="The 123-bit signed integer type."], i123, 123, i128);
678define_signed!(#[doc="The 124-bit signed integer type."], i124, 124, i128);
679define_signed!(#[doc="The 125-bit signed integer type."], i125, 125, i128);
680define_signed!(#[doc="The 126-bit signed integer type."], i126, 126, i128);
681define_signed!(#[doc="The 127-bit signed integer type."], i127, 127, i128);
682
683#[cfg(test)]
684mod tests {
685    use super::*;
686
687    #[test]
688    fn test_masking() {
689        assert_eq!(u4(0b11000110).mask().0, 0b00000110);
690        assert_eq!(u4(0b00001000).mask().0, 0b00001000);
691        assert_eq!(u4(0b00001110).mask().0, 0b00001110);
692
693        assert_eq!(i4(0b11000110u8 as i8).mask().0, 0b00000110u8 as i8);
694        assert_eq!(i4(0b00001000u8 as i8).mask().0, 0b11111000u8 as i8);
695        assert_eq!(i4(0b00001110u8 as i8).mask().0, 0b11111110u8 as i8);
696    }
697
698    #[test]
699    fn min_max_values() {
700        assert_eq!(u1::MAX, u1(1));
701        assert_eq!(u2::MAX, u2(3));
702        assert_eq!(u3::MAX, u3(7));
703        assert_eq!(u7::MAX, u7(127));
704        assert_eq!(u9::MAX, u9(511));
705
706        assert_eq!(i1::MAX, i1(0));
707        assert_eq!(i2::MAX, i2(1));
708        assert_eq!(i3::MAX, i3(3));
709        assert_eq!(i7::MAX, i7(63));
710        assert_eq!(i9::MAX, i9(255));
711
712        assert_eq!(u1::MIN, u1(0));
713        assert_eq!(u2::MIN, u2(0));
714        assert_eq!(u3::MIN, u3(0));
715        assert_eq!(u7::MIN, u7(0));
716        assert_eq!(u9::MIN, u9(0));
717        assert_eq!(u127::MIN, u127(0));
718
719        assert_eq!(i1::MIN, i1(-1));
720        assert_eq!(i2::MIN, i2(-2));
721        assert_eq!(i3::MIN, i3(-4));
722        assert_eq!(i7::MIN, i7(-64));
723        assert_eq!(i9::MIN, i9(-256));
724    }
725
726    #[test]
727    fn test_bits_values() {
728        assert_eq!(u1::BITS, 1);
729        assert_eq!(i7::BITS, 7);
730        assert_eq!(u127::BITS, 127);
731    }
732
733    #[test]
734    fn test_wrapping_add() {
735        assert_eq!(u1::MAX.wrapping_add(u1(1)), u1(0));
736        assert_eq!(u1::MAX.wrapping_add(u1(0)), u1(1));
737
738        assert_eq!(u5::MAX.wrapping_add(u5(1)), u5(0));
739        assert_eq!(u5::MAX.wrapping_add(u5(4)), u5(3));
740
741        assert_eq!(u127::MAX.wrapping_add(u127(100)), u127(99));
742        assert_eq!(u127::MAX.wrapping_add(u127(1)), u127(0));
743
744        assert_eq!(i1::MAX.wrapping_add(i1(0)), i1(0));
745        assert_eq!(i1::MAX.wrapping_add(i1(-1)), i1(-1));
746
747        assert_eq!(i7::MAX.wrapping_add(i7(1)), i7::MIN);
748        assert_eq!(i7::MAX.wrapping_add(i7(4)), i7(-61));
749    }
750
751    #[test]
752    fn test_wrapping_sub() {
753        assert_eq!(u1::MIN.wrapping_sub(u1(1)), u1(1));
754        assert_eq!(u3(1).wrapping_sub(u3(2)), u3::MAX);
755    }
756
757    #[test]
758    #[should_panic]
759    fn test_add_overflow_u5() {
760        let _s = u5::MAX + u5(1);
761    }
762
763    #[test]
764    #[should_panic]
765    fn test_add_overflow_u127() {
766        let _s = u127::MAX + u127(1);
767    }
768
769    #[test]
770    #[should_panic]
771    fn test_add_overflow_i96() {
772        let _s = i96::MAX + i96(100);
773    }
774
775    #[test]
776    #[should_panic]
777    fn test_add_underflow_i96() {
778        let _s = i96::MIN + i96(-100);
779    }
780
781    #[test]
782    #[should_panic]
783    fn test_add_underflow_i17() {
784        let _s = i17::MIN + i17(-1);
785    }
786
787    #[test]
788    fn test_add() {
789        assert_eq!(u5(1) + u5(2), u5(3));
790
791        assert_eq!(i7::MAX + i7::MIN, i7(-1));
792        assert_eq!(i7(4) + i7(-3), i7(1));
793        assert_eq!(i7(-4) + i7(3), i7(-1));
794        assert_eq!(i7(-3) + i7(-20), i7(-23));
795    }
796
797    #[test]
798    #[should_panic]
799    fn test_sub_overflow_i23() {
800        let _s = i23::MIN - i23::MAX;
801    }
802
803    #[test]
804    #[should_panic]
805    fn test_sub_underflow_u5() {
806        let _s = u5::MIN - u5(1);
807    }
808
809    #[test]
810    #[should_panic]
811    fn test_sub_underflow_i5() {
812        let _s = i5::MIN - i5(1);
813    }
814
815    #[test]
816    fn test_sub() {
817        assert_eq!(u5(1) - u5(1), u5(0));
818        assert_eq!(u5(3) - u5(2), u5(1));
819
820        assert_eq!(i1(-1) - i1(-1), i1(0));
821        assert_eq!(i7::MIN - i7::MIN, i7(0));
822        assert_eq!(i7(4) - i7(-3), i7(7));
823        assert_eq!(i7(-4) - i7(3), i7(-7));
824        assert_eq!(i7(-3) - i7(-20), i7(17));
825    }
826
827    #[test]
828    fn test_shr() {
829        assert_eq!(u5(8) >> 1usize, u5(4));
830        assert_eq!(u5(8) >> 1u8, u5(4));
831        assert_eq!(u5(8) >> 1u16, u5(4));
832        assert_eq!(u5(8) >> 1u32, u5(4));
833        assert_eq!(u5(8) >> 1u64, u5(4));
834        assert_eq!(u5(8) >> 1isize, u5(4));
835        assert_eq!(u5(8) >> 1i8, u5(4));
836        assert_eq!(u5(8) >> 1i16, u5(4));
837        assert_eq!(u5(8) >> 1i32, u5(4));
838        assert_eq!(u5(8) >> 1i64, u5(4));
839
840        assert_eq!(u5::MAX >> 4, u5(1));
841
842        assert_eq!(i7(-1) >> 5, i7(-1));
843    }
844
845    #[test]
846    fn test_shl() {
847        assert_eq!(u5(16) << 1usize, u5(0));
848        assert_eq!(u5(16) << 1u8, u5(0));
849        assert_eq!(u5(16) << 1u16, u5(0));
850        assert_eq!(u5(16) << 1u32, u5(0));
851        assert_eq!(u5(16) << 1u64, u5(0));
852        assert_eq!(u5(16) << 1isize, u5(0));
853        assert_eq!(u5(16) << 1i8, u5(0));
854        assert_eq!(u5(16) << 1i16, u5(0));
855        assert_eq!(u5(16) << 1i32, u5(0));
856        assert_eq!(u5(16) << 1i64, u5(0));
857
858        assert_eq!(u5::MAX << 4, u5(16));
859
860        assert_eq!(i5(16) << 1, i5(0));
861        assert_eq!(i7(1) << 3, i7(8));
862    }
863
864    #[test]
865    fn test_shr_assign() {
866        let mut x = u10(512);
867        x >>= 1usize;
868        assert_eq!(x, u10(256));
869        x >>= 1isize;
870        assert_eq!(x, u10(128));
871        x >>= 1u8;
872        assert_eq!(x, u10(64));
873        x >>= 1i8;
874        assert_eq!(x, u10(32));
875        x >>= 2u64;
876        assert_eq!(x, u10(8));
877        x >>= 3i32;
878        assert_eq!(x, u10(1));
879    }
880
881    #[test]
882    fn test_shl_assign() {
883        let mut x = u9(1);
884        x <<= 3i32;
885        assert_eq!(x, u9(8));
886        x <<= 2u64;
887        assert_eq!(x, u9(32));
888        x <<= 1usize;
889        assert_eq!(x, u9(64));
890        x <<= 1isize;
891        assert_eq!(x, u9(128));
892        x <<= 1u8;
893        assert_eq!(x, u9(256));
894        x <<= 1u8;
895        assert_eq!(x, u9(0));
896    }
897
898    #[test]
899    #[allow(clippy::op_ref)]
900    fn test_bitor() {
901        assert_eq!(u9(1) | u9(8), u9(9));
902        assert_eq!(&u9(1) | u9(8), u9(9));
903        assert_eq!(u9(1) | &u9(8), u9(9));
904        assert_eq!(&u9(1) | &u9(8), u9(9));
905    }
906
907    #[test]
908    fn test_bitor_assign() {
909        let mut x = u12(4);
910        x |= u12(1);
911        assert_eq!(x, u12(5));
912        x |= u12(128);
913        assert_eq!(x, u12(133));
914        x = u12(1);
915        x |= u12(127);
916        assert_eq!(x, u12(127));
917    }
918
919    #[test]
920    #[allow(clippy::op_ref)]
921    fn test_bitxor() {
922        assert_eq!(u7(0x7F) ^ u7(42), u7(85));
923        assert_eq!(&u7(0) ^ u7(42), u7(42));
924        assert_eq!(u7(0x10) ^ &u7(0x1), u7(0x11));
925        assert_eq!(&u7(11) ^ &u7(1), u7(10));
926    }
927
928    #[test]
929    fn test_bitxor_assign() {
930        let mut x = u12(4);
931        x ^= u12(1);
932        assert_eq!(x, u12(5));
933        x ^= u12(128);
934        assert_eq!(x, u12(133));
935        x ^= u12(1);
936        assert_eq!(x, u12(132));
937        x ^= u12(127);
938        assert_eq!(x, u12(251));
939    }
940
941    #[test]
942    #[allow(clippy::op_ref)]
943    fn test_bitand() {
944        assert_eq!(i9(-7) & i9(-9), i9::from(-7i8 & -9i8));
945        assert_eq!(&i9(-7) & i9(-9), i9::from(&-7i8 & -9i8));
946        assert_eq!(i9(-7) & &i9(-9), i9::from(-7i8 & &-9i8));
947        assert_eq!(&i9(-7) & &i9(-9), i9::from(&-7i8 & &-9i8));
948
949        assert_eq!(u9(8) & u9(9), u9(8));
950        assert_eq!(&u9(8) & u9(9), u9(8));
951        assert_eq!(u9(8) & &u9(9), u9(8));
952        assert_eq!(&u9(8) & &u9(9), u9(8));
953    }
954
955    #[test]
956    fn test_bitand_assign() {
957        let mut x = u12(255);
958        x &= u12(127);
959        assert_eq!(x, u12(127));
960        x &= u12(7);
961        assert_eq!(x, u12(7));
962        x &= u12(127);
963        assert_eq!(x, u12(7));
964        x &= u12(4);
965        assert_eq!(x, u12(4));
966    }
967
968    #[test]
969    fn test_not() {
970        assert_eq!(!u7(42), u7(85));
971        assert_eq!(!u7(0x7F), u7(0));
972        assert_eq!(!u7(0), u7(0x7F));
973        assert_eq!(!u7(56), u7(71));
974    }
975
976    #[test]
977    #[allow(clippy::single_match)]
978    fn test_match() {
979        const SEVEN: u7 = u7::new(7);
980        match u7(7) {
981            SEVEN => (),
982            _ => panic!("Pattern matching failed (7 != 7?)"),
983        }
984        match u7(42) {
985            SEVEN => panic!("Pattern matching failed (7 == 42?)"),
986            _ => (),
987        }
988    }
989
990    #[test]
991    fn test_mul() {
992        assert_eq!(u1(1) * u1(1), u1(1));
993        assert_eq!(u7(63) * u7(2), u7(126));
994    }
995}
nsw_types/lib.rs

nsw_types/
lib.rs
