Struct BitArray

pub struct BitArray { /* private fields */ }

Implementations

impl BitArray

pub fn new(bit_count: usize) -> Self

Initializes a new BitArray.

Arguments

• bit_count - The maximum number of bits in the array.

Panics

This function will panic if bit_count is zero.

pub fn reset(&mut self)

Resets all bits in the array.

pub const fn all_set(&self) -> bool

Checks if all bits are set.

Returns

• true if all bits in the array are set, otherwise false.

pub fn first_unset_bit(&self) -> Option<usize>

Finds the first bit that is not set in the array.

Returns

• The index of the first unset bit, or None if all bits are set.

pub fn first_set_bit(&self) -> Option<usize>

Finds the first bit that is set in the array.

Returns

• The index of the first set bit, or None if no bits are set.

pub const fn count_set_bits(&self) -> usize

Returns the number of bits that are currently set to 1.

Returns

The number of bits that are set in the BitArray.

pub const fn bit_count(&self) -> usize

Returns the total number of bits in the BitArray.

Returns

The total number of bits in the BitArray.

pub fn set(&mut self, index: usize)

Sets the bit at the given index.

Arguments

• index - The zero-based index of the bit to set.

Panics

This function will panic if the index is out of bounds.

pub fn unset(&mut self, index: usize)

Unsets (clears) the bit at the given index.

Arguments

• index - The zero-based index of the bit to clear.

Panics

This function will panic if the index is out of bounds.

pub fn set_bit(&mut self, index: usize, set: bool)

Sets or unsets the bit at the given index based on the value of set.

Arguments

• index - The zero-based index of the bit to modify.
• set - If true, the bit will be set (1). If false, the bit will be unset (0).

Panics

This function will panic if the index is out of bounds.

pub fn atom_from_index(&self, from_index: usize) -> u64

Returns the atom value that is located at the specified index.

Arguments

• from_index - The index from which to start reading.

Returns

The atom value at the specified index.

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

Returns the bit value at the specified index.

Arguments

• index - The bit index to read from.

Returns

The read bit value (0 or 1).

Panics

This function will panic if the index is out of bounds.

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 BitArray as a binary string with groups of 8 bits separated by a space.

Arguments

• f - The formatter used to output the debug string.

Returns

A Result indicating whether the formatting was successful.

Example

use bit_array_rs::BitArray;
let mut bit_array = BitArray::new(16);
bit_array.set(3);
bit_array.set(7);
bit_array.set(9);
bit_array.set(15);

assert_eq!(format!("{:?}", bit_array), "00010001 01000001");

impl Display for BitArray

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

Formats the BitArray as a continuous binary string without any spaces.

Arguments

• f - The formatter used to output the display string.

Returns

A Result indicating whether the formatting was successful.

Example

use bit_array_rs::BitArray;
let mut bit_array = BitArray::new(16);
bit_array.set(3);
bit_array.set(7);
bit_array.set(9);
bit_array.set(15);

assert_eq!(format!("{}", bit_array), "0001000101000001");

impl Index<usize> for BitArray

fn index(&self, index: usize) -> &Self::Output

Provides indexed access to individual bits in the BitArray.

Arguments

• index - The zero-based index of the bit to access.

Returns

A reference to a boolean value (true or false) representing the state of the bit at the specified index.

Panics

This function will panic if the index is out of bounds.

Example

use bit_array_rs::BitArray;
let mut bit_array = BitArray::new(16);
bit_array.set(3);
assert_eq!(bit_array[3], true);
assert_eq!(bit_array[0], false);

type Output = bool

The returned type after indexing.