roaring/bitmap/
mod.rs

1mod arbitrary;
2mod container;
3mod fmt;
4mod multiops;
5mod proptests;
6mod statistics;
7mod store;
8mod util;
9
10// Order of these modules matters as it determines the `impl` blocks order in
11// the docs
12mod cmp;
13mod inherent;
14mod iter;
15mod ops;
16#[cfg(feature = "std")]
17mod ops_with_serialized;
18#[cfg(feature = "serde")]
19mod serde;
20#[cfg(feature = "std")]
21mod serialization;
22
23use self::cmp::Pairs;
24pub use self::iter::IntoIter;
25pub use self::iter::Iter;
26pub use self::statistics::Statistics;
27
28#[cfg(not(feature = "std"))]
29use alloc::vec::Vec;
30
31/// A compressed bitmap using the [Roaring bitmap compression scheme](https://roaringbitmap.org/).
32///
33/// # Examples
34///
35/// ```rust
36/// use roaring::RoaringBitmap;
37///
38/// let mut rb = RoaringBitmap::new();
39///
40/// // insert all primes less than 10
41/// rb.insert(2);
42/// rb.insert(3);
43/// rb.insert(5);
44/// rb.insert(7);
45/// println!("total bits set to true: {}", rb.len());
46/// ```
47#[derive(PartialEq)]
48pub struct RoaringBitmap {
49    containers: Vec<container::Container>,
50}