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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
use crate::{
binary::Binary,
iters::{Bits, BitsRev, OneIndices, Ones, ZeroIndices, Zeros},
};
/// A trait for easy access of `bitit` iterators.
pub trait BitIter: Binary {
/// Returns an iterator over the value's 0-bits.
///
/// Contains values with one bit set to 1, that being the 0-bit it's representing.
///
/// # Examples
/// ```
/// use bitit::BitIter;
///
/// let x: u8 = 0b10101100;
/// let mut iter = x.zeros();
///
/// assert_eq!(iter.next(), Some(0b00000001));
/// assert_eq!(iter.next(), Some(0b00000010));
/// assert_eq!(iter.next(), Some(0b00010000));
/// assert_eq!(iter.next(), Some(0b01000000));
/// assert_eq!(iter.next(), None);
/// ```
fn zeros(self) -> Zeros<Self> {
Zeros::new(self)
}
/// Returns an iterator over the value's 1-bits.
///
/// Contains values with one bit set to 1, that being the 1-bit it's representing.
///
/// # Examples
/// ```
/// use bitit::BitIter;
///
/// let x: u8 = 0b10101100;
/// let mut iter = x.ones();
///
/// assert_eq!(iter.next(), Some(0b00000100));
/// assert_eq!(iter.next(), Some(0b00001000));
/// assert_eq!(iter.next(), Some(0b00100000));
/// assert_eq!(iter.next(), Some(0b10000000));
/// assert_eq!(iter.next(), None);
/// ```
fn ones(self) -> Ones<Self> {
Ones::new(self)
}
/// Returns an iterator over the indices of the value's 0-bits.
///
/// Contains a `u32` in range `0..N` where `N` is the value's size in bits.
/// The index `0` is the least significant bit, with `N - 1` being the most significant.
///
/// # Examples
/// ```
/// use bitit::BitIter;
///
/// let x: u8 = 0b10101100;
/// let mut iter = x.zero_indices();
///
/// assert_eq!(iter.next(), Some(0));
/// assert_eq!(iter.next(), Some(1));
/// assert_eq!(iter.next(), Some(4));
/// assert_eq!(iter.next(), Some(6));
/// assert_eq!(iter.next(), None);
/// ```
fn zero_indices(self) -> ZeroIndices<Self> {
ZeroIndices::new(self)
}
/// Returns an iterator over the indices of the value's 1-bits.
///
/// Contains a `u32` in range `0..N` where `N` is the value's size in bits.
/// The index `0` is the least significant bit, with `N - 1` being the most significant.
///
/// # Examples
/// ```
/// use bitit::BitIter;
///
/// let x: u8 = 0b10101100;
/// let mut iter = x.one_indices();
///
/// assert_eq!(iter.next(), Some(2));
/// assert_eq!(iter.next(), Some(3));
/// assert_eq!(iter.next(), Some(5));
/// assert_eq!(iter.next(), Some(7));
/// assert_eq!(iter.next(), None);
/// ```
fn one_indices(self) -> OneIndices<Self> {
OneIndices::new(self)
}
/// Returns an iterator over the value's bits.
/// Goes in order from the least significant to most significant bit.
///
/// Contains a `bool`, with `true` meaning the bit is one and `false` meaning it is zero.
///
/// # Examples
/// ```
/// use bitit::BitIter;
///
/// let x: u8 = 0b10101100;
/// 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);
/// ```
fn bits(self) -> Bits<Self> {
Bits::new(self)
}
/// Returns an iterator over the value's bits reversed.
/// Goes in order from the least significant to the most significant bit.
///
/// Contains a `bool`, with `true` meaning the bit is one and `false` meaning it is zero.
///
/// # Examples
/// ```
/// use bitit::BitIter;
///
/// let x: u8 = 0b10101100;
/// let mut iter = x.bits_rev();
///
/// 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(), Some(true));
/// assert_eq!(iter.next(), Some(false));
/// assert_eq!(iter.next(), Some(false));
/// assert_eq!(iter.next(), None);
/// ```
fn bits_rev(self) -> BitsRev<Self> {
BitsRev::new(self)
}
}
impl<T: Binary> BitIter for T {}