Struct ArraySet

pub struct ArraySet<K, const N: usize> { /* private fields */ }

A set backed by an array. All possible keys must be known statically.

This set is O(1) for all operations

Implementations

impl<K, const N: usize> ArraySet<K, N>

pub const fn len(&self) -> usize

Returns the number of keys that this set currently holds

pub const fn is_empty(&self) -> bool

Returns whether this set contains any keys

impl<K: Indexable, const N: usize> ArraySet<K, N>

pub fn new() -> Self

Creates a new, empty ArraySet

pub fn contains(&self, k: K) -> bool

Determines whether a key already exists in the set

pub fn insert(&mut self, k: K) -> bool

Inserts a key into the set and returns whether it was already contained in the set

pub fn remove(&mut self, k: K) -> bool

Removes a key from the set and returns whether it was already contained in the set

pub fn keys(&self) -> impl Iterator<Item = K> + '_

Returns an iterator over all values that are in the set

pub fn is_full(&self) -> bool

Returns whether all possible keys are in the set

pub fn empty() -> Self

Creates a new, empty ArraySet

Panics

Panics if any of the safety requirements in the Indexable trait are wrong

pub fn full() -> Self

Creates a new, full ArraySet

pub fn unset_keys(&self) -> usize

Returns the number of keys that aren’t in the set

impl<K: ReverseIndexable, const N: usize> ArraySet<K, N>

pub fn fast_keys(&self) -> impl Iterator<Item = K> + '_

Returns an iterator over all values that are in the set

impl<K: Indexable> ArraySet<K, 1>

pub fn to_int<U>(self) -> U

where u8: Into<U>,

Returns this set as a u8 (or anything that it can be turned into) with the appropriate bits representing each of the keys in this set.

pub fn from_int(u: u8) -> Self

Creates a new ArraySet from the given u8. Bits may be cleared to ensure this is in a valid state.

impl<K: Indexable> ArraySet<K, 2>

pub fn to_int<U>(self) -> U

where u16: Into<U>,

Returns this set as a u16 (or anything that it can be turned into) with the appropriate bits representing each of the keys in this set.

pub fn from_int(u: u16) -> Self

Creates a new ArraySet from the given u16. Bits may be cleared to ensure this is in a valid state.

impl<K: Indexable> ArraySet<K, 3>

pub fn to_int<U>(self) -> U

where u32: Into<U>,

Returns this set as a u32 (or anything that it can be turned into) with the appropriate bits representing each of the keys in this set.

pub fn from_int(u: u32) -> Self

Creates a new ArraySet from the given u32. Bits may be cleared to ensure this is in a valid state.

impl<K: Indexable> ArraySet<K, 4>

pub fn to_int<U>(self) -> U

where u32: Into<U>,

Returns this set as a u32 (or anything that it can be turned into) with the appropriate bits representing each of the keys in this set.

pub fn from_int(u: u32) -> Self

Creates a new ArraySet from the given u32. Bits may be cleared to ensure this is in a valid state.

impl<K: Indexable> ArraySet<K, 5>

pub fn to_int<U>(self) -> U

where u64: Into<U>,

Returns this set as a u64 (or anything that it can be turned into) with the appropriate bits representing each of the keys in this set.

pub fn from_int(u: u64) -> Self

Creates a new ArraySet from the given u64. Bits may be cleared to ensure this is in a valid state.

impl<K: Indexable> ArraySet<K, 6>

pub fn to_int<U>(self) -> U

where u64: Into<U>,

Returns this set as a u64 (or anything that it can be turned into) with the appropriate bits representing each of the keys in this set.

pub fn from_int(u: u64) -> Self

Creates a new ArraySet from the given u64. Bits may be cleared to ensure this is in a valid state.

impl<K: Indexable> ArraySet<K, 7>

pub fn to_int<U>(self) -> U

where u64: Into<U>,

Returns this set as a u64 (or anything that it can be turned into) with the appropriate bits representing each of the keys in this set.

pub fn from_int(u: u64) -> Self

Creates a new ArraySet from the given u64. Bits may be cleared to ensure this is in a valid state.

impl<K: Indexable> ArraySet<K, 8>

pub fn to_int<U>(self) -> U

where u64: Into<U>,

Returns this set as a u64 (or anything that it can be turned into) with the appropriate bits representing each of the keys in this set.

pub fn from_int(u: u64) -> Self

Creates a new ArraySet from the given u64. Bits may be cleared to ensure this is in a valid state.

Trait Implementations

impl<K: Indexable, const N: usize> Add<K> for ArraySet<K, N>

type Output = ArraySet<K, N>

The resulting type after applying the + operator.

fn add(self, k: K) -> Self::Output

Performs the + operation.

impl<K: Indexable, const N: usize> Add for ArraySet<K, N>

type Output = ArraySet<K, N>

The resulting type after applying the + operator.

fn add(self, k: ArraySet<K, N>) -> Self::Output

Performs the + operation.

impl<K: Indexable, const N: usize> Binary for ArraySet<K, N>

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

Formats the value using the given formatter.

impl<K: Indexable, const N: usize> BitAnd for ArraySet<K, N>

type Output = ArraySet<K, N>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<K: Indexable, const N: usize> BitAndAssign for ArraySet<K, N>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<K: Indexable, const N: usize> BitOr for ArraySet<K, N>

type Output = ArraySet<K, N>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<K: Indexable, const N: usize> BitOrAssign for ArraySet<K, N>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<K: Indexable, const N: usize> BitXor for ArraySet<K, N>

type Output = ArraySet<K, N>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<K: Indexable, const N: usize> BitXorAssign for ArraySet<K, N>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<K, const N: usize> Clone for ArraySet<K, N>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Indexable, const N: usize> Debug for ArraySet<K, N>

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

Formats the value using the given formatter.

impl<K: Indexable, const N: usize> Default for ArraySet<K, N>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K: Deserialize<'de> + Indexable, const N: usize> Deserialize<'de> for ArraySet<K, N>

fn deserialize<D>( deserializer: D, ) -> Result<Self, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: Indexable, const M: usize, const S: usize> From<&ArrayMap<K, AtomicBool, M>> for ArraySet<K, S>

fn from(m: &ArrayMap<K, AtomicBool, M>) -> Self

Converts to this type from the input type.

impl<K: Indexable, const M: usize, const S: usize> From<ArrayMap<K, bool, M>> for ArraySet<K, S>

fn from(m: ArrayMap<K, bool, M>) -> Self

Converts to this type from the input type.

impl<K: Indexable, const M: usize, const S: usize> From<ArraySet<K, S>> for ArrayMap<K, AtomicBool, M>

fn from(s: ArraySet<K, S>) -> Self

Converts to this type from the input type.

impl<K: Indexable, const M: usize, const S: usize> From<ArraySet<K, S>> for ArrayMap<K, bool, M>

fn from(s: ArraySet<K, S>) -> Self

Converts to this type from the input type.

impl<K: Indexable, const N: usize> From<K> for ArraySet<K, N>

fn from(k: K) -> Self

Converts to this type from the input type.

impl<K: Indexable, const N: usize> FromIterator<K> for ArraySet<K, N>

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

Creates a value from an iterator.

impl<K: Indexable, const N: usize> Index<K> for ArraySet<K, N>

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<K: Indexable, const N: usize> Index<usize> for ArraySet<K, N>

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<K: Indexable, const N: usize> IntoIterator for ArraySet<K, N>

type Item = K

The type of the elements being iterated over.

type IntoIter = IntoIter<K, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Indexable, const N: usize> Not for ArraySet<K, N>

type Output = ArraySet<K, N>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<K, const N: usize> PartialEq for ArraySet<K, 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<K: Serialize + Indexable, const N: usize> Serialize for ArraySet<K, N>

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<K: Indexable, const N: usize> Sub<K> for ArraySet<K, N>

type Output = ArraySet<K, N>

The resulting type after applying the - operator.

fn sub(self, k: K) -> Self::Output

Performs the - operation.

impl<K: Indexable, const N: usize> Sub for ArraySet<K, N>

type Output = ArraySet<K, N>

The resulting type after applying the - operator.

fn sub(self, k: ArraySet<K, N>) -> Self::Output

Performs the - operation.

impl<K, const N: usize> Copy for ArraySet<K, N>

impl<K, const N: usize> Eq for ArraySet<K, N>

impl<K, const N: usize> Send for ArraySet<K, N>

impl<K, const N: usize> Sync for ArraySet<K, N>

impl<K, const N: usize> Unpin for ArraySet<K, N>

impl<K, const N: usize> UnwindSafe for ArraySet<K, N>