Struct FzHashSet 

pub struct FzHashSet<T, BH = RandomState> { /* private fields */ }

A set optimized for fast read access with hashable values.

A frozen collection differs from the traditional Rust collections, such as HashMap and 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.

Alternate Choices

If your values are integers or enum variants, you should use the FzScalarSet type instead. If your values are strings, you should use the FzStringSet type instead. Both of these will deliver better performance since they are specifically optimized for those value types.

If your values are known at compile time, consider using the various fz_*_set macros instead of this type as they generally perform better.

Implementations

impl<T> FzHashSet<T>

pub fn new(entries: Vec<T>) -> FzHashSet<T>

where T: Hash + Eq,

Creates a new frozen set. If the input contains duplicate value, the latter one in the input is used and all former ones are discarded.

impl<T, BH> FzHashSet<T, BH>

where BH: BuildHasher,

pub fn with_hasher(entries: Vec<T>, bh: BH) -> FzHashSet<T, BH>

where T: Hash + Eq,

Creates a new frozen set which uses the given hash builder to hash values. If the input contains duplicate value, the latter one in the input is used and all former ones are discarded.

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

where Q: Hash + Equivalent<T> + ?Sized,

Checks whether a particular value is present in the set.

pub fn len(&self) -> usize

Returns the number of elements in the collection.

pub fn is_empty(&self) -> bool

Returns true if the collection contains no elements.

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

An iterator visiting all entries in arbitrary order.

Trait Implementations

impl<T, ST, BH> BitAnd<&ST> for &FzHashSet<T, BH>

where T: Hash + Eq + Clone, ST: Set<T>, BH: BuildHasher,

type Output = HashSet<T>

The resulting type after applying the & operator.

fn bitand(self, rhs: &ST) -> <&FzHashSet<T, BH> as BitAnd<&ST>>::Output

Performs the & operation.

impl<T, ST, BH> BitOr<&ST> for &FzHashSet<T, BH>

where T: Hash + Eq + Clone, ST: Set<T>, BH: BuildHasher,

type Output = HashSet<T>

The resulting type after applying the | operator.

fn bitor(self, rhs: &ST) -> <&FzHashSet<T, BH> as BitOr<&ST>>::Output

Performs the | operation.

impl<T, ST, BH> BitXor<&ST> for &FzHashSet<T, BH>

where T: Hash + Eq + Clone, ST: Set<T>, BH: BuildHasher,

type Output = HashSet<T>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &ST) -> <&FzHashSet<T, BH> as BitXor<&ST>>::Output

Performs the ^ operation.

impl<T, BH> Clone for FzHashSet<T, BH>

where T: Clone, BH: Clone,

fn clone(&self) -> FzHashSet<T, BH>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, BH> Debug for FzHashSet<T, BH>

where T: Debug, BH: BuildHasher,

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

Formats the value using the given formatter.

impl<T, BH> Default for FzHashSet<T, BH>

where BH: Default,

fn default() -> FzHashSet<T, BH>

Returns the “default value” for a type.

impl<'de, T, BH> Deserialize<'de> for FzHashSet<T, BH>

where T: Deserialize<'de> + Hash + Eq, BH: BuildHasher + Default,

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, const N: usize, BH> From<[T; N]> for FzHashSet<T, BH>

where T: Hash + Eq, BH: BuildHasher + Default,

fn from(entries: [T; N]) -> FzHashSet<T, BH>

Converts to this type from the input type.

impl<T, BH> From<FzHashMap<T, (), BH>> for FzHashSet<T, BH>

where T: Hash + Eq, BH: BuildHasher + Default,

fn from(map: FzHashMap<T, (), BH>) -> FzHashSet<T, BH>

Converts to this type from the input type.

impl<T, BH> FromIterator<T> for FzHashSet<T, BH>

where T: Hash + Eq, BH: BuildHasher + Default,

fn from_iter<IT>(iter: IT) -> FzHashSet<T, BH>

where IT: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<'a, T, BH> IntoIterator for &'a FzHashSet<T, BH>

where BH: BuildHasher,

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) -> <&'a FzHashSet<T, BH> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T, BH> IntoIterator for FzHashSet<T, BH>

where BH: BuildHasher,

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) -> <FzHashSet<T, BH> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T, BH> Len for FzHashSet<T, BH>

where BH: BuildHasher,

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, BH> PartialEq<ST> for FzHashSet<T, BH>

where T: PartialEq + Hash, ST: SetQuery<T>, BH: BuildHasher,

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, BH> Serialize for FzHashSet<T, BH>

where T: Serialize, BH: BuildHasher,

Available on crate feature serde only.

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<T, Q, BH> SetExtras<T, Q> for FzHashSet<T, BH>

where Q: Hash + Equivalent<T> + ?Sized, BH: BuildHasher,

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

Gets a reference to a value in the set.

impl<T, BH> SetIteration<T> for FzHashSet<T, BH>

where BH: BuildHasher,

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

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

fn iter(&self) -> <FzHashSet<T, BH> as SetIteration<T>>::Iterator<'_>

An iterator visiting all entries in arbitrary order.

impl<T, Q, BH> SetQuery<Q> for FzHashSet<T, BH>

where Q: Hash + Equivalent<T> + ?Sized, BH: BuildHasher,

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

Checks whether a particular value is present in the set.

impl<T, ST, BH> Sub<&ST> for &FzHashSet<T, BH>

where T: Hash + Eq + Clone, ST: Set<T>, BH: BuildHasher,

type Output = HashSet<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &ST) -> <&FzHashSet<T, BH> as Sub<&ST>>::Output

Performs the - operation.

impl<T, BH> Eq for FzHashSet<T, BH>

where T: Hash + Eq, BH: BuildHasher,

impl<T, Q, BH> Set<T, Q> for FzHashSet<T, BH>

where Q: Hash + Equivalent<T> + ?Sized, BH: BuildHasher,