bitit 0.1.2

Bitwise iteration over integers.
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

use crate::binary::Binary;

/// An iterator over the bits in a value.
/// Represents each bit from least significant to most significant as a boolean.
///
/// # Examples
/// ```
/// use bitit::BitIter;
///
/// let x = 0b10101100u8;
/// let mut iter = x.bits();
///
/// assert_eq!(iter.next(), Some(false));
/// assert_eq!(iter.next(), Some(false));
/// assert_eq!(iter.next(), Some(true));
/// assert_eq!(iter.next(), Some(true));
/// assert_eq!(iter.next(), Some(false));
/// assert_eq!(iter.next(), Some(true));
/// assert_eq!(iter.next(), Some(false));
/// assert_eq!(iter.next(), Some(true));
/// assert_eq!(iter.next(), None);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Bits<T: Binary> {
    /// The value being iterated.
    n: T,

    /// A mask of the bit that is being checked.
    b: T,
}

impl<T: Binary> Bits<T> {
    pub const fn new(n: T) -> Self {
        Self { n, b: T::ONE }
    }
}

impl<T: Binary> Iterator for Bits<T> {
    type Item = bool;

    fn next(&mut self) -> Option<Self::Item> {
        // This will stop when shifting left by one pushes out the single 1-bit.
        self.b.has_one().then(|| {
            // Get the current bit and push the mask.
            let x = self.n & self.b;
            self.b <<= 1;

            x != T::ZERO
        })
    }
}