Struct InlineHashSet 

pub struct InlineHashSet<T, const SZ: usize, const NHS: usize, CM = SmallCollection, H = BridgeHasher> { /* private fields */ }

A general-purpose set implemented using a hash table.

This type is an implementation detail of the `frozen_collections` crate. This API is therefore not stable and may change at any time. Please do not use this type directly, and instead use the public API provided by the `frozen_collections` crate.

A frozen collection differs from the traditional Rust collections, such as [`HashMap`](std::collections::HashMap) and [`HashSet`](std::collections::HashSet) types in three key ways. First, creating a frozen collection performs an analysis over the input data to determine the best implementation strategy. Depending on the situation, this analysis is performed at build time or runtime, and it can take a relatively long time when a collection is very large. Second, once created, the keys in frozen collections are immutable. And third, querying a frozen collection is typically considerably faster, which is the whole point.

This type requires that the keys implement the Eq and Hash traits. This can frequently be achieved by using #[derive(PartialEq, Eq, Hash)]. If you implement these yourself, it is important that the following property holds:

k1 == k2 -> hash(k1) == hash(k2)

In other words, if two keys are equal, their hashes must be equal. Violating this property is a logic error.

It is also a logic error for a key to be modified in such a way that the key’s hash, as determined by the Hash trait, or its equality, as determined by the Eq trait, changes while it is in the collection. This is normally only possible through core::cell::Cell, core::cell::RefCell, global state, I/O, or unsafe code.

The behavior resulting from either logic error can include panics, incorrect results, memory leaks, and non-termination.

Type Parameters

• T: The value type.
• CM: The magnitude of the set, one of SmallCollection, MediumCollection, or LargeCollection.
• SZ: The number of entries in the set.
• NHS: The number of hash table slots.
• H: The hasher to generate hash codes.

Implementations

impl<T, const SZ: usize, const NHS: usize, CM, H> InlineHashSet<T, SZ, NHS, CM, H>

where CM: CollectionMagnitude,

pub const fn new(map: InlineHashMap<T, (), SZ, NHS, CM, H>) -> Self

Creates a frozen set.

pub fn get<Q>(&self, value: &Q) -> Option<&T>

where Q: ?Sized + Equivalent<T>, H: Hasher<Q>,

Gets a reference to a value in the set.

pub fn contains<Q>(&self, value: &Q) -> bool

where Q: ?Sized + Equivalent<T>, H: Hasher<Q>,

Checks whether a particular value is present in the set.

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

An iterator visiting all entries in arbitrary order.

pub const fn len(&self) -> usize

Returns the number of elements in the collection.

pub const fn is_empty(&self) -> bool

Returns true if the collection contains no elements.

Trait Implementations

impl<T, ST, const SZ: usize, const NHS: usize, CM, H> BitAnd<&ST> for &InlineHashSet<T, SZ, NHS, CM, H>

where T: Hash + Eq + Clone, ST: Set<T>, CM: CollectionMagnitude, H: Hasher<T>,

type Output = HashSet<T>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T, ST, const SZ: usize, const NHS: usize, CM, H> BitOr<&ST> for &InlineHashSet<T, SZ, NHS, CM, H>

where T: Hash + Eq + Clone, ST: Set<T>, CM: CollectionMagnitude, H: Hasher<T>,

type Output = HashSet<T>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T, ST, const SZ: usize, const NHS: usize, CM, H> BitXor<&ST> for &InlineHashSet<T, SZ, NHS, CM, H>

where T: Hash + Eq + Clone, ST: Set<T>, CM: CollectionMagnitude, H: Hasher<T>,

type Output = HashSet<T>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T: Clone, const SZ: usize, const NHS: usize, CM: Clone, H: Clone> Clone for InlineHashSet<T, SZ, NHS, CM, H>

fn clone(&self) -> InlineHashSet<T, SZ, NHS, CM, H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, const SZ: usize, const NHS: usize, CM, H> Debug for InlineHashSet<T, SZ, NHS, CM, H>

where T: Debug, CM: CollectionMagnitude, H: Hasher<T>,

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

Formats the value using the given formatter.

impl<'a, T, const SZ: usize, const NHS: usize, CM, H> IntoIterator for &'a InlineHashSet<T, SZ, NHS, CM, H>

where CM: CollectionMagnitude,

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, const SZ: usize, const NHS: usize, CM, H> IntoIterator for InlineHashSet<T, SZ, NHS, CM, H>

where CM: CollectionMagnitude,

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, const SZ: usize, const NHS: usize, CM, H> Len for InlineHashSet<T, SZ, NHS, CM, H>

where CM: CollectionMagnitude,

fn len(&self) -> usize

Returns the number of elements in the collection.

fn is_empty(&self) -> bool

Returns true if the collection contains no elements.

impl<T, ST, const SZ: usize, const NHS: usize, CM, H> PartialEq<ST> for InlineHashSet<T, SZ, NHS, CM, H>

where T: PartialEq, ST: SetQuery<T>, CM: CollectionMagnitude, H: Hasher<T>,

fn eq(&self, other: &ST) -> 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<T, const SZ: usize, const NHS: usize, CM, H> Serialize for InlineHashSet<T, SZ, NHS, CM, H>

where T: Serialize, CM: CollectionMagnitude,

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, Q, const SZ: usize, const NHS: usize, CM, H> SetExtras<T, Q> for InlineHashSet<T, SZ, NHS, CM, H>

where Q: ?Sized + Equivalent<T>, CM: CollectionMagnitude, H: Hasher<Q>,

fn get(&self, value: &Q) -> Option<&T>

Gets a reference to a value in the set.

impl<T, const SZ: usize, const NHS: usize, CM, H> SetIteration<T> for InlineHashSet<T, SZ, NHS, CM, H>

where CM: CollectionMagnitude,

type Iterator<'a> = Iter<'a, T> where T: 'a, CM: 'a, H: 'a

The type of the iterator returned by Self::iter.

fn iter(&self) -> Self::Iterator<'_>

An iterator visiting all entries in arbitrary order.

impl<T, Q, const SZ: usize, const NHS: usize, CM, H> SetQuery<Q> for InlineHashSet<T, SZ, NHS, CM, H>

where Q: ?Sized + Equivalent<T>, CM: CollectionMagnitude, H: Hasher<Q>,

fn contains(&self, value: &Q) -> bool

Checks whether a particular value is present in the set.

impl<T, ST, const SZ: usize, const NHS: usize, CM, H> Sub<&ST> for &InlineHashSet<T, SZ, NHS, CM, H>

where T: Hash + Eq + Clone, ST: Set<T>, CM: CollectionMagnitude, H: Hasher<T>,

type Output = HashSet<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &ST) -> Self::Output

Performs the - operation.

impl<T, const SZ: usize, const NHS: usize, CM, H> Eq for InlineHashSet<T, SZ, NHS, CM, H>

where T: Eq, CM: CollectionMagnitude, H: Hasher<T>,

impl<T, Q, const SZ: usize, const NHS: usize, CM, H> Set<T, Q> for InlineHashSet<T, SZ, NHS, CM, H>

where Q: ?Sized + Equivalent<T>, CM: CollectionMagnitude, H: Hasher<Q>,