Struct Bitmap

pub struct Bitmap<const SIZE: usize>
where
    BitsImpl<SIZE>: Bits,
{ /* private fields */ }

A compact array of bits.

The type used to store the bitmap will be the minimum unsigned integer type required to fit the number of bits, from u8 to u128. If the size is 1, bool is used. If the size exceeds 128, an array of u128 will be used, sized as appropriately. The maximum supported size is currently 1024, represented by an array [u128; 8].

Implementations

impl<const SIZE: usize> Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

pub fn new() -> Self

Construct a bitmap with every bit set to false.

pub fn mask(bits: usize) -> Self

Construct a bitmap where every bit with index less than bits is true, and every other bit is false.

pub fn from_value(data: <BitsImpl<SIZE> as Bits>::Store) -> Self

Construct a bitmap from a value of the same type as its backing store.

pub fn into_value(self) -> <BitsImpl<SIZE> as Bits>::Store

Convert this bitmap into a value of the type of its backing store.

pub fn as_value(&self) -> &<BitsImpl<SIZE> as Bits>::Store

Get a reference to this bitmap’s backing store.

pub fn as_bytes(&self) -> &[u8]

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 is_full(self) -> bool

Test if the bitmap contains only true 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.

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

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

pub fn next_index(self, index: usize) -> Option<usize>

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

pub fn prev_index(self, index: usize) -> Option<usize>

Find the index of the last true bit in the bitmap before index.

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

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

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

Find the index of the last false bit in the bitmap.

pub fn next_false_index(self, index: usize) -> Option<usize>

Find the index of the first false bit in the bitmap after index.

pub fn prev_false_index(self, index: usize) -> Option<usize>

Find the index of the first false bit in the bitmap before index.

pub fn invert(&mut self)

Invert all the bits in the bitmap.

Trait Implementations

impl<const SIZE: usize> AsMut<[u8]> for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<const SIZE: usize> AsRef<[u8]> for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<const SIZE: usize> BitAnd for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

type Output = Bitmap<SIZE>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<const SIZE: usize> BitAndAssign for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<const SIZE: usize> BitOr for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

type Output = Bitmap<SIZE>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<const SIZE: usize> BitOrAssign for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<const SIZE: usize> BitXor for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

type Output = Bitmap<SIZE>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<const SIZE: usize> BitXorAssign for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<const SIZE: usize> Clone for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const SIZE: usize> Debug for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

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

Formats the value using the given formatter.

impl<const SIZE: usize> Default for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

fn default() -> Self

Returns the “default value” for a type.

impl From<[u128; 2]> for Bitmap<256>

fn from(data: [u128; 2]) -> Self

Converts to this type from the input type.

impl From<[u128; 3]> for Bitmap<384>

fn from(data: [u128; 3]) -> Self

Converts to this type from the input type.

impl From<[u128; 4]> for Bitmap<512>

fn from(data: [u128; 4]) -> Self

Converts to this type from the input type.

impl From<[u128; 5]> for Bitmap<640>

fn from(data: [u128; 5]) -> Self

Converts to this type from the input type.

impl From<[u128; 6]> for Bitmap<768>

fn from(data: [u128; 6]) -> Self

Converts to this type from the input type.

impl From<[u128; 7]> for Bitmap<896>

fn from(data: [u128; 7]) -> Self

Converts to this type from the input type.

impl From<[u128; 8]> for Bitmap<1024>

fn from(data: [u128; 8]) -> Self

Converts to this type from the input type.

impl From<Bitmap<1024>> for [u128; 8]

fn from(bitmap: Bitmap<1024>) -> Self

Converts to this type from the input type.

impl From<Bitmap<256>> for [u128; 2]

fn from(bitmap: Bitmap<256>) -> Self

Converts to this type from the input type.

impl From<Bitmap<384>> for [u128; 3]

fn from(bitmap: Bitmap<384>) -> Self

Converts to this type from the input type.

impl From<Bitmap<512>> for [u128; 4]

fn from(bitmap: Bitmap<512>) -> Self

Converts to this type from the input type.

impl From<Bitmap<640>> for [u128; 5]

fn from(bitmap: Bitmap<640>) -> Self

Converts to this type from the input type.

impl From<Bitmap<768>> for [u128; 6]

fn from(bitmap: Bitmap<768>) -> Self

Converts to this type from the input type.

impl From<Bitmap<896>> for [u128; 7]

fn from(bitmap: Bitmap<896>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> Hash for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits, <BitsImpl<SIZE> as Bits>::Store: Hash,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl<'a, const SIZE: usize> IntoIterator for &'a Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

type Item = usize

The type of the elements being iterated over.

type IntoIter = Iter<'a, SIZE>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const SIZE: usize> Not for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

type Output = Bitmap<SIZE>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<const SIZE: usize> Ord for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits, <BitsImpl<SIZE> as Bits>::Store: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const SIZE: usize> PartialEq for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

fn eq(&self, other: &Self) -> 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<const SIZE: usize> PartialOrd for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits, <BitsImpl<SIZE> as Bits>::Store: PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const SIZE: usize> TryFrom<&[u8]> for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<const SIZE: usize> Copy for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,

impl<const SIZE: usize> Eq for Bitmap<SIZE>

where BitsImpl<SIZE>: Bits,