bit_fiddler 2.1.1

Macros for common bit operations with multiple convenient patterns
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

/// Macro for getting a bit mask over the given range.
///
/// # Example
///
/// ```
/// use bit_fiddler::mask;
///
/// let mask = mask!([0..64], u64);
/// assert_eq!(mask, u64::MAX);
///
/// let bitmap: u8 = 0b_1010_1010;
/// let masked_bitmap = bitmap & mask!([0..4], u8);
/// assert_eq!(masked_bitmap, 0b_0000_1010);
///
/// let bitmap: u8 = 0b_1111_1111;
/// let masked_bitmap = bitmap & mask!([3..], u8);
/// assert_eq!(masked_bitmap, 0b_1111_1000);
///
/// let bitmap: u8 = 0b_1111_1111;
/// let masked_bitmap = bitmap & mask!(rev [0..4], u8);
/// assert_eq!(masked_bitmap, 0b_1111_0000);
///
/// let bitmap: u8 = 0b_1111_1111;
/// let masked_bitmap = bitmap & mask!([start = 3, count = 4], u8);
/// assert_eq!(masked_bitmap, 0b_0111_1000);
/// ```
#[macro_export]
macro_rules! mask {
    ([..$end: tt], $ty: ty) => {
        {
            let max_bits = $crate::max_bits!(type = $ty);
            !(0 as $ty) >> (max_bits - $end)
        }
    };
    ([$start: tt..], $ty: ty) => {
        {
            !(0 as $ty) << $start
        }
    };
    ([..], $ty: ty) => {
        {
            !(0 as $ty)
        }
    };
    ([$start: tt..$end: tt], $ty: ty) => {
        {
            let max_bits = $crate::max_bits!(type = $ty);
            (!(0 as $ty) << $start) & (!(0 as $ty) >> (max_bits - $end))
        }
    };
    (rev [$start: tt..], $ty: ty) => {
        {
            !(0 as $ty) >> $start
        }
    };
    (rev [..$end: tt], $ty: ty) => {
        {
            let max_bits = $crate::max_bits!(type = $ty);
            !(0 as $ty) << (max_bits - $end)
        }
    };
    (rev [..], $ty: ty) => {
        {
            !(0 as $ty)
        }
    };
    (rev [$start: tt..$end: tt], $ty: ty) => {
        {
            let max_bits = $crate::max_bits!(type = $ty);
            (!(0 as $ty) << (max_bits - $end)) & (!(0 as $ty) >> $start)
        }
    };
    ([start = $start: tt, count = $count: tt], $ty: ty) => {
        {
            $crate::mask!([$start..($start + $count)], ($ty))
        }
    };
    (rev [start = $start: tt, count = $count: tt], $ty: ty) => {
        {
            $crate::mask!(rev [$start..($start + $count)], ($ty))
        }
    };
}