#bits #flags #iterator #bit-twiddling

no-std bit-iter

Iterate forward or backwards over the positions of set bits in a word

6 releases (stable)

1.2.0 Aug 24, 2023
1.1.1 May 18, 2022
1.1.0 Nov 12, 2021
0.1.6 Sep 29, 2021
0.1.4 Jun 23, 2021

#178 in Algorithms

Download history 1502/week @ 2023-08-06 1488/week @ 2023-08-13 1693/week @ 2023-08-20 1137/week @ 2023-08-27 957/week @ 2023-09-03 2339/week @ 2023-09-10 2871/week @ 2023-09-17 2560/week @ 2023-09-24 1007/week @ 2023-10-01 908/week @ 2023-10-08 801/week @ 2023-10-15 1100/week @ 2023-10-22 1472/week @ 2023-10-29 1383/week @ 2023-11-05 1142/week @ 2023-11-12 1060/week @ 2023-11-19

5,156 downloads per month
Used in 3 crates

MIT license

13KB
258 lines

bit-iter

Test results Crates.io Documentation

Iterate forwards or backwards over the positions of bits set in a word.

A BitIter may be constructed from any integral value, and returns the positions of the 1 bits in ascending order.

BitIter implements DoubleEndedIterator, so you can iterate over the positions of the set bits in descending order too.

Example

fn main() {
    use bit_iter::*;

    let x : u32 = 0x10001;

    for b in BitIter::from(x) {
        println!("Bit {} is set.", b);
    }

    println!("In reverse order:");

    for b in BitIter::from(x).rev() {
        println!("Bit {} is set.", b);
    }
}

Output:

Bit 0 is set.
Bit 16 is set.
In reverse order:
Bit 16 is set.
Bit 0 is set.

Minimum supported Rust version (MSRV) policy

bit-iter's current minimum supported Rust version (MSRV) is 1.53.0.

bit-iter is guaranteed to compile with that version. It might also compile with older versions, but that could change in a future patch release.

If the MSRV of bit-iter changes, that will be done in a minor version release (e.g. 1.2.x -> 1.3.0).

No runtime deps