Struct StackBitSet

pub struct StackBitSet<const N: usize>
where
    [(); { _ }]: Sized,
{ /* private fields */ }

BitSet with compile-time size. It does not require any allocation and is entirely stored on the stack.

The only field is an array of usize. Each element is stored in a bit

Examples

use stack_bitset::StackBitSet;

let mut a: StackBitSet<42> = StackBitSet::new();
a.set(12).unwrap();
assert!(a.get(12).unwrap());

Implementations

impl<const N: usize> StackBitSet<N>

where [(); { _ }]: Sized,

pub fn new() -> Self

Create a new empty instance of the bitset

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

pub fn iter_limit(&self, limit: usize) -> StackBitSetIterator<'_, N>

pub fn get(&self, idx: usize) -> Result<bool, StackBitSetError>

Returns whether the elements at index idx in the bitset is set

pub fn set(&mut self, idx: usize) -> Result<(), StackBitSetError>

sets the elements at index idx in the bitset

pub fn reset(&mut self, idx: usize) -> Result<(), StackBitSetError>

Resets the element at index idx in the bitset

impl<const N: usize> StackBitSet<N>

where [(); { _ }]: Sized,

pub fn union<const M: usize>( &self, other: &StackBitSet<M>, ) -> StackBitSet<{ _ }>

where [(); { _ }]: Sized,

pub fn intersection<const M: usize>( &self, other: &StackBitSet<M>, ) -> StackBitSet<{ _ }>

where [(); { _ }]: Sized,

pub fn difference<const M: usize>( &self, other: &StackBitSet<M>, ) -> StackBitSet<{ _ }>

where [(); { _ }]: Sized,

pub fn complement(&self) -> StackBitSet<N>

pub fn is_subset<const M: usize>(&self, other: &StackBitSet<M>) -> bool

where [(); { _ }]: Sized,

pub fn is_equal<const M: usize>(&self, other: &StackBitSet<M>) -> bool

where [(); { _ }]: Sized,

pub fn is_superset<const M: usize>(&self, other: &StackBitSet<M>) -> bool

where [(); { _ }]: Sized,

Trait Implementations

impl<const N: usize, const M: usize> Add<&StackBitSet<M>> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<{ const_min(N, M) }>

The resulting type after applying the + operator.

fn add(self, other: &StackBitSet<M>) -> Self::Output

Performs the + operation.

impl<const N: usize> Add<f32> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: f32) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<f64> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: f64) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<i128> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: i128) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<i16> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: i16) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<i32> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: i32) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<i64> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: i64) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<i8> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: i8) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<isize> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: isize) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<u128> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: u128) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<u16> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: u16) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<u32> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: u32) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<u64> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: u64) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<u8> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: u8) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Add<usize> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the + operator.

fn add(self, other: usize) -> StackBitSet<N>

Performs the + operation.

impl<const N: usize> Clone for StackBitSet<N>

where [(); { _ }]: Sized,

fn clone(&self) -> StackBitSet<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where [(); { _ }]: Sized,

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

Formats the value using the given formatter.

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

where [(); { _ }]: Sized,

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Sub<f32> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: f32) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<f64> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: f64) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<i128> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: i128) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<i16> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: i16) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<i32> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: i32) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<i64> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: i64) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<i8> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: i8) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<isize> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: isize) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<u128> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: u128) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<u16> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: u16) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<u32> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: u32) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<u64> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: u64) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<u8> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: u8) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Sub<usize> for StackBitSet<N>

where [(); { _ }]: Sized,

type Output = StackBitSet<N>

The resulting type after applying the - operator.

fn sub(self, other: usize) -> StackBitSet<N>

Performs the - operation.

impl<const N: usize> Copy for StackBitSet<N>

where [(); { _ }]: Sized,