Enum Bitmap

pub enum Bitmap {
    Roaring(RoaringBitmap),
    BitVec(BitVec),
}

A bitmap representation supporting both BitVec and RoaringBitmap formats.

This enum provides unified bitmap operations while allowing efficient storage in different formats. The implementation automatically handles type conversions when performing operations between different formats.

Examples

Creating a new Roaring bitmap:

use bitmap::Bitmap;
let bitmap = Bitmap::new_roaring();
assert!(bitmap.is_empty());

Creating a full BitVec bitmap:

use bitmap::Bitmap;
let bitmap = Bitmap::full_bitvec(10);
assert_eq!(bitmap.count_ones(), 10);

Variants

Roaring(RoaringBitmap)

BitVec(BitVec)

Implementations

impl Bitmap

pub fn new_bitvec() -> Self

Creates a new empty BitVec-based bitmap.

pub fn new_roaring() -> Self

Creates a new empty RoaringBitmap-based bitmap.

pub fn full_bitvec(size: usize) -> Self

Creates a full BitVec-based bitmap with all bits set to 1.

Arguments

• size - The number of bits to allocate and set

pub fn full_roaring(size: usize) -> Self

Creates a full RoaringBitmap-based bitmap with bits 0..size set to 1.

Arguments

• size - The exclusive upper bound for the bit range

pub fn count_ones(&self) -> usize

Returns the number of bits set to 1 in the bitmap.

pub fn is_empty(&self) -> bool

Checks if the bitmap contains no set bits.

pub fn insert_range(&mut self, range: RangeInclusive<usize>)

Inserts a range of bits into the bitmap.

Arguments

• range - Inclusive range of bits to set

pub fn serialize_into( &self, serialize_type: BitmapType, writer: impl Write, ) -> Result<()>

Serializes the bitmap into a byte buffer using the specified format.

Arguments

• serialize_type - Target format for serialization
• writer - Output writer to write the serialized data

pub fn serialized_size(&self, bitmap_type: BitmapType) -> usize

Computes the size of the serialized bitmap in bytes.

Arguments

• bitmap_type - Format of data to be serialized

pub fn deserialize_from(buf: &[u8], bitmap_type: BitmapType) -> Result<Self>

Deserializes a bitmap from a byte buffer.

Arguments

• buf - Input buffer containing serialized data
• bitmap_type - Format of the serialized data

pub fn union(&mut self, other: Self)

Computes the union with another bitmap (in-place).

If the other bitmap is a different type, it will be converted to match the current bitmap’s type.

pub fn intersect(&mut self, other: Self)

Computes the intersection with another bitmap (in-place).

If the other bitmap is a different type, it will be converted to match the current bitmap’s type.

pub fn iter_ones(&self) -> Box<dyn Iterator<Item = usize> + '_>

Returns an iterator over the indices of set bits.

pub fn from_lsb0_bytes(bytes: &[u8], bitmap_type: BitmapType) -> Self

Creates a bitmap from bytes in LSB0 (least significant bit first) order.

Arguments

• bytes - Input bytes in LSB0 order
• bitmap_type - Type of bitmap to create

pub fn memory_usage(&self) -> usize

Computes memory usage of the bitmap in bytes.

fn into_bitvec(self) -> BitVec

fn into_roaring(self) -> RoaringBitmap

fn roaring_to_bitvec(roaring: &RoaringBitmap) -> BitVec

fn bitvec_to_roaring(bitvec: BitVec) -> RoaringBitmap

Trait Implementations

impl Clone for Bitmap

fn clone(&self) -> Bitmap

Returns a copy 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() -> Self

Returns the “default value” for a type.

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 StructuralPartialEq for Bitmap