Struct Interner

pub struct Interner<I: Intern + ?Sized, S: Symbol = DefaultSymbol, H = DefaultHashBuilder> { /* private fields */ }

Data structure to intern and resolve strings.

Caches strings efficiently, with minimal memory footprint and associates them with unique symbols. These symbols allow constant time comparisons and look-ups to the underlying interned strings.

The following API covers the main functionality:

• Interner::intern: To intern a new string.
  • This maps from string type to symbol type.
• Interner::resolve: To resolve your already interned strings.
  • This maps from symbol type to string type.

Implementations

impl<I: Intern + ?Sized, S: Symbol, H: BuildHasher + Default> Interner<I, S, H>

pub fn new() -> Self

Creates a new empty Interner.

pub fn with_capacity(cap: usize) -> Self

Creates a new StringInterner with the given initial capacity.

impl<I: Intern + ?Sized, S: Symbol, H: BuildHasher> Interner<I, S, H>

pub fn with_hasher(hash_builder: H) -> Self

Creates a new empty StringInterner with the given hasher.

pub fn with_capacity_and_hasher(cap: usize, hash_builder: H) -> Self

Creates a new empty StringInterner with the given initial capacity and the given hasher.

pub fn len(&self) -> usize

Returns the number of strings interned by the interner.

pub fn is_empty(&self) -> bool

Returns true if the string interner has no interned strings.

pub fn get<T>(&self, string: T) -> Option<S>

where T: AsRef<I>,

Returns the symbol for the given string if any.

Can be used to query if a string has already been interned without interning.

pub fn intern_and_hash<T: AsRef<I>>(&mut self, string: T) -> (S, u64)

Interns the given string.

Returns a symbol for resolution into the original string, and its hash.

Panics

If the interner already interns the maximum number of strings possible by the chosen symbol type.

pub fn intern<T: AsRef<I>>(&mut self, string: T) -> S

Interns the given string.

Returns a symbol for resolution into the original string.

Panics

If the interner already interns the maximum number of strings possible by the chosen symbol type.

pub fn shrink_to_fit(&mut self)

Shrink backend capacity to fit the interned strings exactly.

pub fn resolve(&self, symbol: S) -> Option<&I>

Returns the string for the given `symbol`` if any.

pub fn get_hash(&self, symbol: S) -> Option<u64>

Returns cached hash of the string for the given symbol.

pub unsafe fn resolve_unchecked(&self, symbol: S) -> &I

Returns the string for the given symbol without performing any checks.

Safety

It is the caller’s responsibility to provide this method with symbols that are valid for the Interner.

pub unsafe fn get_hash_unchecked(&self, symbol: S) -> u64

Returns cached hash of the string for the given symbol without performing any checks.

Safety

It is the caller’s responsibility to provide this method with symbols that are valid for the Interner.

pub fn iter_with_hashes(&self) -> IterWithHashes<'_, I, S>

Returns an iterator that yields all interned strings, their symbols, and hashes.

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

Returns an iterator that yields all interned strings and their symbols.

Trait Implementations

impl<I: Intern + ?Sized, S: Symbol, H: Clone> Clone for Interner<I, S, H>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Intern + ?Sized, S, H> Debug for Interner<I, S, H>

where S: Debug + Symbol, H: BuildHasher,

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

Formats the value using the given formatter.

impl<I: Intern + ?Sized, S: Symbol, H: BuildHasher + Default> Default for Interner<I, S, H>

fn default() -> Self

Returns the “default value” for a type.

impl<I: Intern + ?Sized, S: Symbol, H: BuildHasher + Default, T: AsRef<I>> Extend<T> for Interner<I, S, H>

fn extend<It>(&mut self, iter: It)

where It: IntoIterator<Item = T>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<I: Intern + ?Sized, S: Symbol, H: BuildHasher + Default, T: AsRef<I>> FromIterator<T> for Interner<I, S, H>

fn from_iter<It>(iter: It) -> Self

where It: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<'a, I: Intern + ?Sized, S: Symbol, H> IntoIterator for &'a Interner<I, S, H>

type Item = (S, &'a I)

The type of the elements being iterated over.

type IntoIter = Iter<'a, I, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.