Struct RawBitmapGeneric 

pub struct RawBitmapGeneric<S: Storage> { /* private fields */ }

A simple bitmap backed by generic storage.

Implementations

impl<S: Storage> RawBitmapGeneric<S>

pub const fn new(bits: S) -> Self

Create a new raw bitmap with the given storage.

pub fn size(&self) -> usize

Returns the size of this bitmap.

pub fn storage(&self) -> &S

Access the underlying storage read-only.

pub fn storage_mut(&mut self) -> &mut S

Access the underlying storage mutably.

pub fn shrink(&mut self, size: usize) -> Result<(), Status>

Shrinks the accessible portion of the bitmap, without re-allocating the underlying storage.

This is useful for programs which require underlying bitmap storage to be aligned to a certain size (initialized via Reset), but want to restrict access to a smaller portion of the bitmap (via Shrink).

pub fn scan(&self, bitoff: usize, bitmax: usize, is_set: bool) -> Option<usize>

Returns true if all bits in the range [bitoff, bitmax) match is_set.

If they do not match, returns false and the index of the first bit that doesn’t match. An empty region (i.e. bitoff >= bitmax) will return true.

pub fn reverse_scan( &self, bitoff: usize, bitmax: usize, is_set: bool, ) -> Option<usize>

Returns true if all bits in the range [bitoff, bitmax) match is_set, scanning in reverse.

If they do not match, returns false and the index of the last bit that doesn’t match. An empty region (i.e. bitoff >= bitmax) will return true.

pub fn reverse_find( &self, is_set: bool, bitoff: usize, bitmax: usize, run_len: usize, ) -> Result<usize, Status>

Finds the last run of run_len is_set bits, in [bitoff, bitmax).

Returns the start of the run, or Status::NO_RESOURCES if not found.

pub fn grow(&mut self, size: usize) -> Result<(), Status>

Increases the bitmap size.

pub fn reset(&mut self, size: usize) -> Result<(), Status>

Resets the bitmap; clearing and resizing it.

Allocates memory, and can fail.

Trait Implementations

impl<S: Storage> Bitmap<usize> for RawBitmapGeneric<S>

fn find( &self, is_set: bool, bitoff: usize, bitmax: usize, run_len: usize, ) -> Result<usize, Status>

Finds a run of run_len is_set bits, between bitoff and bitmax.

fn get(&self, bitoff: usize, bitmax: usize) -> GetResult<usize>

Returns true if all the bits in [bitoff, bitmax) are set.

fn set(&mut self, bitoff: usize, bitmax: usize) -> Result<(), Status>

Sets all bits in the range [bitoff, bitmax).

fn clear(&mut self, bitoff: usize, bitmax: usize) -> Result<(), Status>

Clears all bits in the range [bitoff, bitmax).

fn clear_all(&mut self)

Clear all bits in the bitmap.

fn get_one(&self, bitoff: T) -> bool

Returns true if the bit at bitoff is set.

fn set_one(&mut self, bitoff: T) -> Result<(), Status>

Sets the bit at bitoff.

fn clear_one(&mut self, bitoff: T) -> Result<(), Status>

Clears the bit at bitoff.

impl<S: Debug + Storage> Debug for RawBitmapGeneric<S>

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

Formats the value using the given formatter.

impl<S: Default + Storage> Default for RawBitmapGeneric<S>

fn default() -> RawBitmapGeneric<S>

Returns the “default value” for a type.