Struct BitVec

Source

pub struct BitVec { /* private fields */ }

Expand description

A simple bit vector implementation.

Implementations§

Source §

impl BitVec

Source

pub fn iter(&self) -> Iter<'_> ⓘ

Returns an iterator over the bits of the vector.

§Examples

use bitvek::bitvec;

let vec = bitvec![true, false, true, false];
let mut iter = vec.iter();

assert_eq!(iter.next(), Some(true));
assert_eq!(iter.next(), Some(false));
assert_eq!(iter.next_back(), Some(false));
assert_eq!(iter.next_back(), Some(true));
assert_eq!(iter.next(), None);
assert_eq!(iter.next_back(), None);

Source §

impl BitVec

Source

pub fn new() -> Self

Creates a new empty BitVec.

§Examples

use bitvek::BitVec;

let vec = BitVec::new();

Source

pub fn with_capacity(capacity: usize) -> Self

Creates a new empty BitVec with the specified capacity.

The final capacity will be at least as large as (capacity / 8 + 1) * 8.

§Examples

use bitvek::BitVec;

let vec = BitVec::with_capacity(10);
assert!(vec.capacity() >= 16);

Source §

impl BitVec

Source

pub fn capacity(&self) -> usize

Returns the total number of bits the vector can hold without reallocating.

§Examples

use bitvek::bitvec;

let vec = bitvec![true, false, true, false];
assert!(vec.capacity() >= 8);

§Notes

The capacity of the vector is always a multiple of 8.

Source

pub fn len(&self) -> usize

Returns the number of bits in the vector.

§Examples

use bitvek::bitvec;

let vec = bitvec![true, false, true, false];
assert_eq!(vec.len(), 4);

Source

pub fn is_empty(&self) -> bool

Returns true if the vector contains no bits.

§Examples

use bitvek::bitvec;

let vec = bitvec![];
assert!(vec.is_empty());

let vec = bitvec![true, false, true, false];
assert!(!vec.is_empty());

Source §

impl BitVec

Source

pub fn shrink_to_fit(&mut self) -> &mut Self

Shrinks the capacity of the vector as much as possible.

§Examples

use bitvek::BitVec;

let mut vec = BitVec::with_capacity(10);
vec.extend([true, false, true]);
assert!(vec.capacity() >= 16);
vec.shrink_to_fit();
assert!(vec.capacity() >= 8);

Source

pub fn shrink_to(&mut self, min_capacity: usize) -> &mut Self

Shrinks the capacity of the vector with a lower bound.

The capacity will remain at least as large as (self.len().max(min_capacity) / 8 + 1) * 8.

If the current capacity is less than the lower limit, this is a no-op.

§Examples

use bitvek::BitVec;

let mut vec = BitVec::with_capacity(20);
vec.extend([true, false, true]);
assert!(vec.capacity() >= 24);
vec.shrink_to(10);
assert!(vec.capacity() >= 16);
vec.shrink_to(0);
assert!(vec.capacity() >= 8);

Source

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

Returns the bit at the specified index, if in bounds.

§Examples

use bitvek::bitvec;

let vec = bitvec![true, false, true, false];
assert_eq!(vec.get(3), Some(false));
assert_eq!(vec.get(4), None);

Source

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

Returns the bit at the specified index, without performing any bounds checking.

§Safety

Calling this method with an out-of-bounds index is undefined behavior.

§Examples

use bitvek::bitvec;

let vec = bitvec![true, false, true, false];
unsafe { assert_eq!(vec.get_unchecked(3), false) };

Source

pub fn set(&mut self, index: usize, value: bool) -> Option<&mut Self>

Sets the bit at the specified index to the specified value, if in bounds.

§Examples

use bitvek::bitvec;

let expected = bitvec![true, true, true, true];

let mut vec = bitvec![true, false, true, false];
assert!(vec.set(1, true).is_some());
assert!(vec.set(3, true).is_some());
assert!(vec.set(4, true).is_none());
assert_eq!(vec, expected);

Source

pub unsafe fn set_unchecked(&mut self, index: usize, value: bool) -> &mut Self

Sets the bit at the specified index to the specified value, without performing any bounds checking.

§Safety

Calling this method with an out-of-bounds index is undefined behavior.

§Examples

use bitvek::bitvec;

let expected = bitvec![true, true, true, true];

let mut vec = bitvec![true, false, true, false];
unsafe {
    vec.set_unchecked(1, true);
    vec.set_unchecked(3, true);
}
assert_eq!(vec, expected);

Source

pub fn push(&mut self, value: bool) -> Option<&mut Self>

Appends a bit to the end of the vector, or returns None if the length of the vector reaches usize::MAX.

§Examples

use bitvek::bitvec;

let expected = bitvec![true, false, true, false, true];

let mut vec = bitvec![true, false, true, false];
assert!(vec.push(true).is_some());
assert_eq!(vec, expected);

Source

pub fn pop(&mut self) -> Option<bool>

Removes the last bit from the vector and returns it, or None if the vector is empty.

§Examples

use bitvek::bitvec;

let expected = bitvec![true, false, true];

let mut vec = bitvec![true, false, true, false];
assert_eq!(vec.pop(), Some(false));
assert_eq!(vec, expected);