Struct yabf::Yabf

pub struct Yabf { /* fields omitted */ }

Yet another bit field implementation. This is a simple, small and hopefully efficient bit field implementation.

It is intended for cases where a program iterates over list or other usize indexed containers and simple bit based bookkeeping is required.

Implementations

impl Yabf

pub fn with_capacity(bits: usize) -> Self

Construct an empty bit field with enough capacity pre-allocated to store at least n bits.

let bf = Yabf::with_capacity(100);

assert!(bf.is_empty());
assert!(bf.capacity() >= 100);

pub fn bit(&self, n: usize) -> bool

Returns the value of the ‘n’:th bit in the bit field.

let mut bf = Yabf::default();

assert!(bf.is_empty());
assert!(!bf.bit(10));
bf.set_bit(10,true);
assert!(bf.bit(10));

pub fn set_bit(&mut self, n: usize, state: bool)

Sets the ‘n’:th bit in the bit field. If the bit field capacity is not large enough more space will be allocated.

let mut bf = Yabf::default();

assert!(bf.is_empty());
assert!(!bf.bit(10));
bf.set_bit(10,true);
assert!(bf.bit(10));

pub fn is_empty(&self) -> bool

Returns true if all bits are set to false

pub fn capacity(&self) -> usize

The number of bits the bit field can hold without reallocating

pub fn internal_len(&self) -> usize

The len() of the internal vector

pub fn reserve(&mut self, additional_bits: usize)

Reserve capacity for additional_bits more bits to be inserted.

May reserve more space to avoid frequent re-allocations.

Panics if the capacity computation overflows usize.

pub fn clear(&mut self)

Remove all elements from the vector. This method simply delegates clear() to the underlying vector std::vec::Vec or smallvec::SmallVec. So what actually happen depends on the feature set.

Trait Implementations

impl BitOrAssign<&'_ Yabf> for Yabf

bit or assign operation. This is a relatively expensive O(size of container) operation.

let mut a = Yabf::default();
let mut b = Yabf::default();
a.set_bit(45,true);
b.set_bit(12345,true);
assert!(!a.bit(12345));
assert!(a.bit(45));
a |= &b;
assert!(a.bit(12345));
assert!(a.bit(45));

fn bitor_assign(&mut self, other: &Yabf)

Performs the |= operation.

impl Clone for Yabf

fn clone(&self) -> Yabf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Yabf

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

Formats the value using the given formatter.

impl Default for Yabf

fn default() -> Self

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a Yabf

type Item = usize

The type of the elements being iterated over.

type IntoIter = YabfIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.