Struct ittybitty::IttyBitty

pub struct IttyBitty<const N: usize> { /* private fields */ }

A memory-access optimized dynamically sized bitset.

IttyBitty<N> is backed by a [usize; N], but can spill to heap allocation.

Implementations

impl<const N: usize> IttyBitty<N>

pub const fn new() -> Self

Create an empty inline IttyBitty

pub fn with_capacity(bits: usize) -> Self

Create an empty inline IttyBitty with enough capacity to hold bits

pub fn capacity(&self) -> usize

Get the current capacity of the IttyBitty

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

Get the bit at bit without bounds checks.

pub unsafe fn set_unchecked(&mut self, bit: usize, val: bool)

Set the bit at bit without bounds checks.

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

Get the bit at bit. Returns false if beyond capacity.

pub fn set(&mut self, bit: usize, value: bool)

Set the bit at bit to value. Extends capacity as needed if value is true, no-op if false and beyond bounds.

pub fn clear(&mut self)

Set all bits to false.

pub fn truncate(&mut self, bit: usize)

Set bit and all bits beyond it to false.

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

Iterate over true bits.

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

Gets the first true bit after bit.

Trait Implementations

impl<const N: usize> Debug for IttyBitty<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for IttyBitty<N>

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Drop for IttyBitty<N>

fn drop(&mut self)

Executes the destructor for this type.

impl<const N: usize> Index<usize> for IttyBitty<N>

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, const N: usize> IntoIterator for &'a IttyBitty<N>

type Item = usize

The type of the elements being iterated over.

type IntoIter = Iter<'a, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, N>

Creates an iterator from a value.

impl<const N: usize> IntoIterator for IttyBitty<N>

type Item = usize

The type of the elements being iterated over.

type IntoIter = IntoIter<N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<N>

Creates an iterator from a value.

impl<const N: usize> PartialEq for IttyBitty<N>

fn eq(&self, other: &Self) -> 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<const N: usize> Eq for IttyBitty<N>