fantasy-util 0.2.2

Jelipo custom utils
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

/// 对于usize值的扩展方法
pub trait BitUtil<T> {
    /// 获取指定长度的位，其他位置0
    ///
    /// #Example
    /// ```
    /// use fantasy_util::bit::usize::BitUtil;
    ///
    /// let a:u32 = 0b1001_1001 as u32;
    /// let i:u32 = a.extract(3,4); // i = 0b0000_0011;
    /// ```
    fn extract(self, off: u8, len: u8) -> T;

    /// 获取指定位的bool值
    ///
    /// #Example
    /// ```
    /// use fantasy_util::bit::usize::BitUtil;
    ///
    /// let a:u32 = 0b1001_1001 as u32;
    /// let b:bool = a.get_bit_bool(0); // b=true;
    /// ```
    fn get_bit_bool(self, bit: u8) -> bool;

    /// 获取指定位
    /// #Example
    /// ```
    /// use fantasy_util::bit::usize::BitUtil;
    ///
    /// let a:u32 = 0b1001_1001 as u32;
    /// let b:bool = a.get_bit_bool(0); // b = true;
    /// ```
    fn get_bit(self, bit: u8) -> u8;
}

impl BitUtil<u8> for u8 {
    #[inline(always)]
    fn extract(self, off: u8, len: u8) -> u8 { (self >> off) & ((1u8 << len) - 1) }

    #[inline(always)]
    fn get_bit_bool(self, bit: u8) -> bool { self.get_bit(bit) != 0 }

    #[inline(always)]
    fn get_bit(self, bit: u8) -> u8 { ((self >> bit) as u8) & 1 }
}

impl BitUtil<u16> for u16 {
    #[inline(always)]
    fn extract(self, off: u8, len: u8) -> u16 { (self >> off) & ((1u16 << len) - 1) }

    #[inline(always)]
    fn get_bit_bool(self, bit: u8) -> bool { self.get_bit(bit) != 0 }

    #[inline(always)]
    fn get_bit(self, bit: u8) -> u8 { ((self >> bit) as u8) & 1 }
}


impl BitUtil<u32> for u32 {
    #[inline(always)]
    fn extract(self, off: u8, len: u8) -> u32 { (self >> off) & ((1u32 << len) - 1) }

    #[inline(always)]
    fn get_bit_bool(self, bit: u8) -> bool { self.get_bit(bit) != 0 }

    #[inline(always)]
    fn get_bit(self, bit: u8) -> u8 { ((self >> bit) as u8) & 1 }
}

impl BitUtil<u64> for u64 {
    #[inline(always)]
    fn extract(self, off: u8, len: u8) -> u64 { (self >> off) & ((1u64 << len) - 1) }

    #[inline(always)]
    fn get_bit_bool(self, bit: u8) -> bool { self.get_bit(bit) != 0 }

    #[inline(always)]
    fn get_bit(self, bit: u8) -> u8 { ((self >> bit) as u8) & 1 }
}


impl BitUtil<u128> for u128 {
    #[inline(always)]
    fn extract(self, off: u8, len: u8) -> u128 { (self >> off) & ((1u128 << len) - 1) }

    #[inline(always)]
    fn get_bit_bool(self, bit: u8) -> bool { self.get_bit(bit) != 0 }

    #[inline(always)]
    fn get_bit(self, bit: u8) -> u8 { ((self >> bit) as u8) & 1 }
}


#[cfg(test)]
mod tests {
    use crate::bit::usize::BitUtil;

    #[test]
    fn it_works() {
        let a: u32 = 0b1001_1001;
        let i = a.extract(3, 4);
        assert_eq!(0b0011, i);
    }
}