Struct BitArray

pub struct BitArray { /* private fields */ }

Implementations

impl BitArray

pub fn new(size: usize) -> Self

Returns a zero-cleared bit array of size size.

pub fn with_word_size(word_size: usize, len: usize) -> Self

pub fn size(&self) -> usize

Returns the size (byte) of the array.

pub fn set_bit(&mut self, i: usize, b: bool)

Sets the bit at position i to b.

Examples

let mut ba = fid::BitArray::new(8);
ba.set_bit(3, true);
assert_eq!(ba.get_bit(3), true);
assert_eq!(ba.get_bit(4), false);
ba.set_bit(256, true);  // automatically extended
assert_eq!(ba.get_bit(256), true);

pub fn get_bit(&self, i: usize) -> bool

Gets the bit at position i.

Panics

Panics if the specified position exceeds the capacity.

pub fn set_slice(&mut self, i: usize, slice_size: usize, slice: u64)

Gets the slice of size slice_size at position i.

Panics

Panics if slice_size is greater than 64.

pub fn set_word(&mut self, i: usize, word_size: usize, word: u64)

Sets the i-th word of size word_size to word.

Examples

let mut ba = fid::BitArray::new(128);
ba.set_word(0, 12, 0b0101_1010_1100);
assert_eq!(ba.get_word(0, 12), 0b0101_1010_1100);
ba.set_word(5, 12, 0b1010_0101_0011);
assert_eq!(ba.get_word(5, 12), 0b1010_0101_0011);

pub fn get_slice(&self, i: usize, slice_size: usize) -> u64

Gets the slice of size slice_size at position i.

Panics

Panics if the end position of the slice exceeds the capacity or slice_size is greater than 64.

pub fn get_word(&self, i: usize, word_size: usize) -> u64

Gets the i-th word of size word_size.

pub fn resize(&mut self, new_size: usize)

Resizes the array.

Trait Implementations

impl Clone for BitArray

fn clone(&self) -> BitArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitArray

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BitArray

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BitArray

fn eq(&self, other: &BitArray) -> 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 Serialize for BitArray

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BitArray