Struct Bitmap 

pub struct Bitmap { /* private fields */ }

A 64-bit roaring-style compressed bitmap.

This is an append-only data structure optimized for memory efficiency and fast set operations. Values can be inserted but not removed.

Example

use commonware_utils::bitmap::roaring::Bitmap;

let mut bitmap = Bitmap::new();
bitmap.insert(42);
bitmap.insert(100);
bitmap.insert_range(1000..2000);

assert!(bitmap.contains(42));
assert!(bitmap.contains(1500));
assert!(!bitmap.contains(500));

// Iterate over values
for value in bitmap.iter().take(10) {
    println!("{}", value);
}

Implementations

impl Bitmap

pub fn union(&self, other: &Self, limit: u64) -> Self

Computes the union of two bitmaps, returning at most limit values.

Pass u64::MAX for unlimited results.

pub fn intersection(&self, other: &Self, limit: u64) -> Self

Computes the intersection of two bitmaps, returning at most limit values.

Pass u64::MAX for unlimited results.

pub fn difference(&self, other: &Self, limit: u64) -> Self

Computes the difference self - other, returning at most limit values.

Pass u64::MAX for unlimited results.

pub fn is_subset(&self, other: &Self) -> bool

Returns true if every value in this bitmap is present in other.

pub fn intersects(&self, other: &Self) -> bool

Returns true if the bitmaps share at least one value.

impl Bitmap

pub const fn new() -> Self

Creates an empty roaring bitmap.

pub fn len(&self) -> u64

Returns the number of values in the bitmap.

pub fn is_empty(&self) -> bool

Returns whether the bitmap is empty.

pub fn container_count(&self) -> usize

Returns the number of containers in the bitmap.

pub fn clear(&mut self)

Clears all values from the bitmap.

pub fn contains(&self, value: u64) -> bool

Checks if the bitmap contains the given value.

pub fn insert(&mut self, value: u64) -> bool

Inserts a value into the bitmap.

Returns true if the value was newly inserted, false if it already existed.

pub fn insert_range(&mut self, range: Range<u64>) -> u64

Inserts a range of values into the bitmap.

Returns the number of values newly inserted.

pub fn iter(&self) -> impl Iterator<Item = u64> + '_

Returns an iterator over the values in sorted order.

pub fn iter_range(&self, range: Range<u64>) -> impl Iterator<Item = u64> + '_

Returns an iterator over the values in the range in sorted order.

pub fn min(&self) -> Option<u64>

Returns the minimum value in the bitmap, if any.

pub fn max(&self) -> Option<u64>

Returns the maximum value in the bitmap, if any.

Trait Implementations

impl Clone for Bitmap

fn clone(&self) -> Bitmap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Bitmap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Bitmap

fn default() -> Bitmap

Returns the “default value” for a type.

impl EncodeSize for Bitmap

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the working buffer for inline writes. Override alongside Write::write_bufs for types where large Bytes fields go via push; failing to do so will over-allocate.

impl Extend<u64> for Bitmap

fn extend<I: IntoIterator<Item = u64>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<u64> for Bitmap

fn from_iter<I: IntoIterator<Item = u64>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for Bitmap

fn eq(&self, other: &Bitmap) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for Bitmap

type Cfg = RangeCfg<usize>

Configuration for decoding: range limit on number of containers.

Use RangeCfg::new(..=max_containers) to limit memory allocation.

fn read_cfg(buf: &mut impl Buf, cfg: &Self::Cfg) -> Result<Self, CodecError>

Reads a value from the buffer using the provided configuration cfg.

impl Write for Bitmap

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing Bytes chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.

impl Eq for Bitmap

impl StructuralPartialEq for Bitmap