Struct dyn_bitmap::DynBitmap

pub struct DynBitmap { /* fields omitted */ }

Dynamicaly sized bitmap.

let mut bitmap = dyn_bitmap::DynBitmap::contained(3);
bitmap.set(0, true).unwrap();
bitmap.set(2, true).unwrap();
assert!(bitmap.get(0).unwrap());
assert!(!bitmap.get(1).unwrap());
assert!(bitmap.get(2).unwrap());

Implementations

impl DynBitmap

pub fn contained(bits: usize) -> Self

Create new bitmap that is guaranteed to hold that many bits.

Example

use dyn_bitmap::DynBitmap;
let bimap = DynBitmap::contained(13);

pub const fn bytes_required(bits: usize) -> usize

Amount of bytes required for bitmap serialization.

Example

use dyn_bitmap::DynBitmap;
let bitmap = DynBitmap::contained(10);
assert_eq!(bitmap.byte_size(), DynBitmap::bytes_required(10));

pub fn get(&self, bit_index: usize) -> Result<bool, Error>

Get bit value.

Example

let mut bitmap = dyn_bitmap::DynBitmap::contained(3);
bitmap.set(0, true).unwrap();
assert!(bitmap.get(0).unwrap());
assert!(!bitmap.get(1).unwrap());

pub fn set(&mut self, bit_index: usize, value: bool) -> Result<(), Error>

Set bit value as true.

Example

let mut bitmap = dyn_bitmap::DynBitmap::contained(3);
assert!(!bitmap.get(0).unwrap());
bitmap.set(0, true).unwrap();
assert!(bitmap.get(0).unwrap());

pub fn write<W: Write>(&self, writer: W) -> Result<()>

Write bitmap by impl std::io::Write.

Example

let mut bitmap = dyn_bitmap::DynBitmap::contained(8);

bitmap.set(0, true).unwrap();
bitmap.set(2, true).unwrap();
bitmap.set(4, true).unwrap();
bitmap.set(6, true).unwrap();

let mut buffer: Vec<u8> = Default::default();
let mut cursor = std::io::Cursor::new(&mut buffer);
bitmap.write(cursor).unwrap();
assert_eq!(&buffer, &0b0101_0101u8.to_le_bytes());

pub fn byte_size(&self) -> usize

Size of bitmap in bytes.

Example

let bitmap = dyn_bitmap::DynBitmap::contained(9);
assert_eq!(bitmap.byte_size(), 2);

pub fn arity(&self) -> usize

Bitmap bits capacity.

Example

let bitmap = dyn_bitmap::DynBitmap::contained(9);
assert_eq!(bitmap.arity(), 9);

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

Iterate over the bitmap.

Example

use dyn_bitmap::DynBitmap;

let bitmap: DynBitmap = std::iter::repeat(true).take(128).collect();
let all: bool = bitmap.iter().all(|b| b);

Trait Implementations

impl Debug for DynBitmap

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

Formats the value using the given formatter.

impl FromIterator<bool> for DynBitmap

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

Creates a value from an iterator.