Struct tinybitset::TinyBitSet

pub struct TinyBitSet<T: BitBlock, const N: usize> { /* private fields */ }

A small, fixed size bitset that stores its data inline.

Storage and indexing

The bitsets storage consists of N blocks of type T, where T is any of the unsigned integer types implementing BitBlock. Thus, the bitset has a fixed size of T::BITS * N bits can be freely converted to and from the array of blocks.

The bits are indexed from front to back within the array of blocks, and from least significant to most significant within each block. Thus, the bit with index i is stored in the (i / T::BITS)-th block in the (i % T::BITS)-th least significant bit.

Implementations

impl<T: BitBlock, const N: usize> TinyBitSet<T, N>

pub const CAPACITY: usize = _

Number of bits in the bitset.

pub const EMPTY: Self = _

Bitset with no bits set.

pub const ALL: Self = _

Bitset with all bits set.

pub const fn new() -> Self

Creates an empty bitset.

Equivalent to Self::EMPTY.

pub fn singleton(bit: usize) -> Self

Creates a bitset with exactly one bit set.

Panics

Panics if bit >= Self::CAPACITY.

pub const fn capacity(self) -> usize

Number of bits in the bitset.

Equivalent to Self::CAPACITY.

pub fn len(self) -> usize

Counts the number of bits that are set.

pub fn is_empty(self) -> bool

Returns whether no bits are set.

pub fn iter(self) -> IntoIter<T, N>

Iterates over the indices of set bits from lowest to highest.

pub fn iter_missing(self) -> IntoIter<T, N>

Iterates over the indices of unset bits from lowest to highest.

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

Set the given bit.

Panics

Panics if bit >= Self::CAPACITY.

pub fn inserted(self, bit: usize) -> Self

Return a new bitset with the given bit set.

Panics

Panics if bit >= Self::CAPACITY.

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

Unset the given bit.

Panics

Panics if bit >= Self::CAPACITY.

pub fn removed(self, bit: usize) -> Self

Return a new bitset with the given bit unset.

Panics

Panics if bit >= Self::CAPACITY.

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

Flip the given bit.

Panics

Panics if bit >= Self::CAPACITY.

pub fn toggled(self, bit: usize) -> Self

Return a new bitset with the given bit flipped.

Panics

Panics if bit >= Self::CAPACITY.

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

Sets the given bit to the given value.

Panics

Panics if bit >= Self::CAPACITY.

pub fn assigned(self, bit: usize, value: bool) -> Self

Return a new bitset with the given bit set to the given value.

Panics

Panics if bit >= Self::CAPACITY.

Trait Implementations

impl<T: BitBlock, const N: usize> Binary for TinyBitSet<T, N>

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

Formats the value using the given formatter.

impl<T: BitBlock, const N: usize> BitAnd for TinyBitSet<T, N>

fn bitand(self, rhs: Self) -> Self::Output

Returns a bitset with all bits that are set in both self and rhs.

type Output = TinyBitSet<T, N>

The resulting type after applying the & operator.

impl<T: BitBlock, const N: usize> BitAndAssign for TinyBitSet<T, N>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<T: BitBlock, const N: usize> BitOr for TinyBitSet<T, N>

fn bitor(self, rhs: Self) -> Self::Output

Returns a bitset with all bits that are set in either self or rhs.

type Output = TinyBitSet<T, N>

The resulting type after applying the | operator.

impl<T: BitBlock, const N: usize> BitOrAssign for TinyBitSet<T, N>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<T: BitBlock, const N: usize> BitXor for TinyBitSet<T, N>

fn bitxor(self, rhs: Self) -> Self::Output

Returns a bitset with all bits that are set in exactly one of self and rhs.

type Output = TinyBitSet<T, N>

The resulting type after applying the ^ operator.

impl<T: BitBlock, const N: usize> BitXorAssign for TinyBitSet<T, N>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<T: Clone + BitBlock, const N: usize> Clone for TinyBitSet<T, N>

fn clone(&self) -> TinyBitSet<T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: BitBlock, const N: usize> Debug for TinyBitSet<T, N>

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

Formats the value using the given formatter.

impl<T: BitBlock, const N: usize> Default for TinyBitSet<T, N>

fn default() -> Self

Returns Self::EMPTY.

impl<T: BitBlock, const N: usize> Display for TinyBitSet<T, N>

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

Formats the value using the given formatter.

impl<T: BitBlock, const N: usize> From<[T; N]> for TinyBitSet<T, N>

fn from(blocks: [T; N]) -> Self

Create a bitset from the underlying bit blocks.

See TinyBitSet for more information on how the bits are indexed.

impl<T: BitBlock> From<T> for TinyBitSet<T, 1>

fn from(block: T) -> Self

Create a bitset from the underlying bit block.

impl<T: BitBlock, const N: usize> From<TinyBitSet<T, N>> for [T; N]

fn from(bitset: TinyBitSet<T, N>) -> Self

Convert the bitset into the underlying bit blocks.

See TinyBitSet for more information on how the bits are indexed.

impl From<TinyBitSet<u128, 1>> for u128

fn from(bitset: TinyBitSet<u128, 1>) -> Self

Convert the bitset into the underlying bit block.

Due to the orphan rule, this cannot be covered by a blanket implementation and is thus separately implemented for all primitive integer types.

impl From<TinyBitSet<u16, 1>> for u16

fn from(bitset: TinyBitSet<u16, 1>) -> Self

Convert the bitset into the underlying bit block.

Due to the orphan rule, this cannot be covered by a blanket implementation and is thus separately implemented for all primitive integer types.

impl From<TinyBitSet<u32, 1>> for u32

fn from(bitset: TinyBitSet<u32, 1>) -> Self

Convert the bitset into the underlying bit block.

Due to the orphan rule, this cannot be covered by a blanket implementation and is thus separately implemented for all primitive integer types.

impl From<TinyBitSet<u64, 1>> for u64

fn from(bitset: TinyBitSet<u64, 1>) -> Self

Convert the bitset into the underlying bit block.

Due to the orphan rule, this cannot be covered by a blanket implementation and is thus separately implemented for all primitive integer types.

impl From<TinyBitSet<u8, 1>> for u8

fn from(bitset: TinyBitSet<u8, 1>) -> Self

Convert the bitset into the underlying bit block.

Due to the orphan rule, this cannot be covered by a blanket implementation and is thus separately implemented for all primitive integer types.

impl<T: BitBlock, const N: usize> FromIterator<usize> for TinyBitSet<T, N>

fn from_iter<I: IntoIterator<Item = usize>>(iter: I) -> Self

Creates a bitset with an iterator of indices of set bits.

Panics

Panics if any of the indices are out of range.

impl<T: Hash + BitBlock, const N: usize> Hash for TinyBitSet<T, N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: BitBlock, const N: usize> Index<usize> for TinyBitSet<T, N>

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T: BitBlock, const N: usize> IntoIterator for &TinyBitSet<T, N>

type Item = usize

The type of the elements being iterated over.

type IntoIter = IntoIter<T, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: BitBlock, const N: usize> IntoIterator for TinyBitSet<T, N>

type Item = usize

The type of the elements being iterated over.

type IntoIter = IntoIter<T, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: BitBlock, const N: usize> LowerHex for TinyBitSet<T, N>

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

Formats the value using the given formatter.

impl<T: BitBlock, const N: usize> Not for TinyBitSet<T, N>

fn not(self) -> Self::Output

Returns a bitset with all bits flipped.

type Output = TinyBitSet<T, N>

The resulting type after applying the ! operator.

impl<T: Ord + BitBlock, const N: usize> Ord for TinyBitSet<T, N>

fn cmp(&self, other: &TinyBitSet<T, N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq + BitBlock, const N: usize> PartialEq for TinyBitSet<T, N>

fn eq(&self, other: &TinyBitSet<T, N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd + BitBlock, const N: usize> PartialOrd for TinyBitSet<T, N>

fn partial_cmp(&self, other: &TinyBitSet<T, N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: BitBlock, const N: usize> UpperHex for TinyBitSet<T, N>

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

Formats the value using the given formatter.

impl<T: Copy + BitBlock, const N: usize> Copy for TinyBitSet<T, N>

impl<T: Eq + BitBlock, const N: usize> Eq for TinyBitSet<T, N>

impl<T: BitBlock, const N: usize> StructuralEq for TinyBitSet<T, N>

impl<T: BitBlock, const N: usize> StructuralPartialEq for TinyBitSet<T, N>