Struct sized_chunks::bitmap::Bitmap

pub struct Bitmap<Size: Bits> { /* fields omitted */ }

A compact array of bits.

The bitmap is stored as a primitive type, so the maximum value of Size is currently 128, corresponding to a type of u128. The type used to store the bitmap will be the minimum unsigned integer type required to fit the number of bits required, from u8 to u128.

Examples

let mut bitmap = Bitmap::<U10>::new();
assert_eq!(bitmap.set(5, true), false);
assert_eq!(bitmap.set(5, true), true);
assert_eq!(bitmap.get(5), true);
assert_eq!(bitmap.get(6), false);
assert_eq!(bitmap.len(), 1);
assert_eq!(bitmap.set(3, true), false);
assert_eq!(bitmap.len(), 2);
assert_eq!(bitmap.first_index(), Some(3));

Methods

impl<Size: Bits> Bitmap<Size>

pub fn new() -> Self

Construct an empty bitmap.

pub fn len(self) -> usize

Count the number of true bits in the bitmap.

pub fn is_empty(self) -> bool

Test if the bitmap contains only false bits.

pub fn get(self, index: usize) -> bool

Get the value of the bit at a given index.

pub fn set(&mut self, index: usize, value: bool) -> bool

Set the value of the bit at a given index.

Returns the previous value of the bit.

pub fn first_index(self) -> Option<usize>

Find the index of the first true bit in the bitmap.

Trait Implementations

impl<Size: Bits> Copy for Bitmap<Size>

impl<Size: Bits> IntoIterator for Bitmap<Size>

type Item = usize

The type of the elements being iterated over.

type IntoIter = Iter<Size>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Size: Bits> Default for Bitmap<Size>

fn default() -> Self

Returns the "default value" for a type.

impl<Size: Bits> Clone for Bitmap<Size>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Size: Bits> PartialEq<Bitmap<Size>> for Bitmap<Size>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Size: Bits> Debug for Bitmap<Size>

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

Formats the value using the given formatter.