bitops 0.1.0

Miscellaneous bit operations for any Integer.
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

//! Miscellaneous bit operations for any [`Integer`].
//!
//! See the [`BitOps`] trait for examples.
//!
//! [`Integer`]: ../num_integer/trait.Integer.html
//! [`BitOps`]: ./trait.BitOps.html

extern crate num_integer;

use num_integer::Integer;
use std::ops::{BitAnd, Shl, Shr};

/// Miscellaneous bit operations for any [`Integer`].
///
/// # Examples
///
/// ```
/// use bitops::BitOps;
///
/// let x = 0b1010_1011_0000_1100; // 0xab0c
/// let flag = 0b1000;
///
/// assert!(flag.is_flag());
/// assert!(flag.is_bit_set(3));
///
/// assert!(x.is_flag_set(flag));
/// assert_eq!(x.bits_as_int(8, 4), 0xb);
/// ```
///
/// [`Integer`]: ../num_integer/trait.Integer.html
pub trait BitOps:
    Copy + Integer + BitAnd<Output = Self> + Shl<Output = Self> + Shr<Output = Self> + From<u8>
{
    /// Returns whether this number only has one bit set.
    ///
    /// # Examples
    ///
    /// ```
    /// use bitops::BitOps;
    ///
    /// assert!(0b1000.is_flag());
    /// assert!(!0b1001.is_flag());
    /// ```
    #[inline]
    fn is_flag(&self) -> bool {
        *self > Self::zero() && (*self & (*self - Self::one())) == Self::zero()
    }

    /// Returns whether the given bit number is set.
    ///
    /// # Panics
    ///
    /// Panics if `bit` is greater than the number of bits in this Integer.
    ///
    /// # Examples
    ///
    /// ```
    /// use bitops::BitOps;
    ///
    /// assert!(0b1000.is_bit_set(3));
    /// ```
    #[inline]
    fn is_bit_set(&self, bit: u8) -> bool {
        self.is_flag_set(Self::one() << Self::from(bit))
    }

    /// Returns whether the given flag is set.
    ///
    /// # Examples
    ///
    /// ```
    /// use bitops::BitOps;
    ///
    /// assert!(0b11010.is_flag_set(0b11000));
    /// ```
    #[inline]
    fn is_flag_set(&self, flag: Self) -> bool {
        *self & flag > Self::zero()
    }

    /// Returns a number with bit 0 starting at the given bit and up to `count` left most bits.
    /// This is basically a right shift by `bit` and masked with `(1 << count) - 1`.
    ///
    /// # Panics
    ///
    /// Panics if `bit` is greater than the number of bits in this Integer.
    ///
    /// # Examples
    ///
    /// ```
    /// use bitops::BitOps;
    ///
    /// assert_eq!(0xab000.bits_as_int(12, 8), 0xab);
    /// ```
    #[inline]
    fn bits_as_int(&self, bit: u8, count: u8) -> Self {
        (*self >> Self::from(bit)) & ((Self::one() << Self::from(count)) - Self::one())
    }
}

/// Implements the [`BitOps`] trait for all types that meet the requirements.
impl<N> BitOps for N
where
    N: Copy + Integer + BitAnd<Output = Self> + Shl<Output = Self> + Shr<Output = Self> + From<u8>,
{
}

mod tests {
    #[allow(unused_imports)]
    use super::BitOps;

    #[test]
    fn flag_zero() {
        assert!(!0.is_flag());
    }

    #[test]
    fn flag_set_blank() {
        assert!(!0x0000.is_flag_set(0));
    }

    #[test]
    fn bits_at_zero() {
        assert_eq!(0xabcd.bits_as_int(0, 8), 0xcd);
    }

    #[test]
    #[should_panic]
    fn bits_overflow() {
        0u16.bits_as_int(16, 0);
    }
}