Adding `cbitset` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add cbitset

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

cbitset = "0.2.0"

The cbitset library will be automatically available globally. Read the cbitset library documentation.

Back to the crate overview.

Readme

cbitset

A bit set, being able to hold a fixed amount of booleans in an array of integers.

Alternatives

There are already quite a few libraries out there for bit sets, but I can't seem to find a #![no_std] one that works with fixed-sized arrays. Most of them seem to want to be dynamic.

cbitset also is repr(transparent), meaning the representation of the struct is guaranteed to be the same as the inner array, making it usable from stuff where the struct representation is important, such as relibc.

Inspiration

I think this is a relatively common thing to do in C, for I stumbled upon the concept in the MUSL standard library. An example is its usage in strspn.

While it's a relatively easy concept, the implementation can be pretty unreadable. So maybe it should be abstracted away with some kind of... zero cost abstraction?

Example

Bit sets are extremely cheap. You can store any number from 0 to 255 in an array of 4x 64-bit numbers. Lookup should in theory be O(1). An example usage of this is once again strspn. Here it is in rust, using this library:

/// The C standard library function strspn, reimplemented in rust. It works by
/// placing all allowed values in a bit set, and returning on the first
/// character not on the list. A BitSet256 uses no heap allocations and only 4
/// 64-bit integers in stack memory.
fn strspn(s: &[u8], accept: &[u8]) -> usize {
    let mut allow = BitSet256::new();

    for &c in accept {
        allow.insert(c as usize);
    }

    for (i, &c) in s.iter().enumerate() {
        if !allow.contains(c as usize) {
            return i;
        }
    }
    s.len()
}

Adding cbitset library as a dependency

Adding `cbitset` library as a dependency