growable-bitmap
is a Rust crate providing a growable (and shrinkable) compact
boolean array that can be parameterized on its storage type.
THIS CRATE IS NOT CONSIDERED PRODUCTION READY AT THE MOMENT.
This crate is not feature-complete at all. Below are some features I want
to add before marking it as 1.0
:
BitOr
(with another GrowableBitMap
).BitOrAssign
(with another GrowableBitMap
).BitAnd
(with another GrowableBitMap
).BitAndAssign
(with another GrowableBitMap
).BitXor
(with another GrowableBitMap
).BitXorAssign
(with another GrowableBitMap
).
When const-generics
become available, possibly use them as storage ?
[Rust 1.48.0+ / Intra-doc links]: Use intra-doc links in documentation. Right now there are no links because they're painful to write once you've been introduced to the wonder intra-doc links are.
Add this to your Cargo.toml
:
toml
[dependencies]
growable-bitmap = "0.2"
and, if you're using Rust Edition 2015, this to your crate root:
rust
extern crate growable_bitmap;
But bitmaps are not a new problem, why a new crate ?
This is true, in fact there are two libraries on crates.io
that provides
bitmaps already:
bitmap
: marked as complete since 2016,
which means it does not leverage new APIs in the standard library. Not a bad
thing if you want absolute stability though.bitmaps
: Only fixed-size arrays, which
is an explicit non-goal of growable-bitmap
. bitmaps
and growable-bitmap
complement each other and you should choose the correct one for you usage.And I wanted to make a bitmap crate because I think bitmaps are a very cool data structure and I love using Rust to build things.
See the LICENSE
file at the root of the repository.