Struct FzStringSet 

pub struct FzStringSet<T, BH = DefaultBuildHasher> { /* private fields */ }

A set optimized for fast read access with string 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.

Implementations

impl FzStringSet<Box<str>, DefaultBuildHasher>

pub fn new(entries: Vec<impl AsRef<str>>) -> Self

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<BH> FzStringSet<Box<str>, BH>

pub fn with_hasher(entries: Vec<impl AsRef<str>>, bh: BH) -> Self

where BH: BuildHasher + Clone + Send + Sync + 'static,

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.

impl<'a> FzStringSet<&'a str, DefaultBuildHasher>

pub fn new_for_str(entries: Vec<&'a str>) -> Self

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<'a, BH> FzStringSet<&'a str, BH>

pub fn with_hasher_for_str(entries: Vec<&'a str>, bh: BH) -> Self

where BH: BuildHasher + Clone + Send + Sync + 'static,

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.

impl<T, BH> FzStringSet<T, BH>

pub fn get(&self, value: impl AsRef<str>) -> Option<&T>

where BH: BuildHasher, str: Equivalent<T>,

Gets a reference to a value in the set.

pub fn contains(&self, value: impl AsRef<str>) -> bool

where BH: BuildHasher, str: Equivalent<T>,

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 &FzStringSet<T, BH>

where T: Hash + Eq + Clone + AsRef<str>, ST: Set<T>, BH: BuildHasher + Default, str: Equivalent<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, BH> BitOr<&ST> for &FzStringSet<T, BH>

where T: Hash + Eq + Clone + AsRef<str>, ST: Set<T>, BH: BuildHasher + Default, str: Equivalent<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, BH> BitXor<&ST> for &FzStringSet<T, BH>

where T: Hash + Eq + Clone + AsRef<str>, ST: Set<T>, BH: BuildHasher + Default, str: Equivalent<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, BH: Clone> Clone for FzStringSet<T, BH>

fn clone(&self) -> FzStringSet<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 FzStringSet<T, BH>

where T: Debug,

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

Formats the value using the given formatter.

impl<BH> Default for FzStringSet<&str, BH>

where BH: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<BH> Default for FzStringSet<Box<str>, BH>

where BH: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, BH> Deserialize<'de> for FzStringSet<Box<str>, BH>

where BH: BuildHasher + Default + Clone + Send + Sync + 'static,

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, const N: usize, BH> From<[&'a str; N]> for FzStringSet<&'a str, BH>

where BH: BuildHasher + Default + Clone + Send + Sync + 'static,

fn from(entries: [&'a str; N]) -> Self

Converts to this type from the input type.

impl<T, const N: usize, BH> From<[T; N]> for FzStringSet<Box<str>, BH>

where T: AsRef<str>, BH: BuildHasher + Default + Clone + Send + Sync + 'static,

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

Converts to this type from the input type.

impl<T, BH> From<FzStringMap<T, (), BH>> for FzStringSet<T, BH>

fn from(map: FzStringMap<T, (), BH>) -> Self

Converts to this type from the input type.

impl<'a, BH> FromIterator<&'a str> for FzStringSet<&'a str, BH>

where BH: BuildHasher + Default + Clone + Send + Sync + 'static,

fn from_iter<IT: IntoIterator<Item = &'a str>>(iter: IT) -> Self

Creates a value from an iterator.

impl<T, BH> FromIterator<T> for FzStringSet<Box<str>, BH>

where T: AsRef<str>, BH: BuildHasher + Default + Clone + Send + Sync + 'static,

fn from_iter<IT: IntoIterator<Item = T>>(iter: IT) -> Self

Creates a value from an iterator.

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

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, BH> IntoIterator for FzStringSet<T, BH>

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, BH> Len for FzStringSet<T, BH>

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 FzStringSet<T, BH>

where ST: SetQuery<T>, BH: BuildHasher + Default,

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 FzStringSet<T, BH>

where T: Serialize,

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

where Q: AsRef<str>, BH: BuildHasher, str: Equivalent<T>,

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

Gets a reference to a value in the set.

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

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

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

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

An iterator visiting all entries in arbitrary order.

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

where Q: AsRef<str>, BH: BuildHasher, str: Equivalent<T>,

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

Checks whether a particular value is present in the set.

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

where T: Hash + Eq + Clone + AsRef<str>, ST: Set<T>, BH: BuildHasher + Default, str: Equivalent<T>,

type Output = HashSet<T>

The resulting type after applying the - operator.

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

Performs the - operation.

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

where T: AsRef<str>, BH: BuildHasher + Default, str: Equivalent<T>,

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

where Q: AsRef<str>, BH: BuildHasher, str: Equivalent<T>,