Struct arc_string_interner::StringInterner

pub struct StringInterner<S, H, const N: usize> where
    S: Symbol,
    H: BuildHasher,  { /* fields omitted */ }

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.

Implementations

impl<S, const N: usize> StringInterner<S, RandomState, N> where
    S: Symbol, 

pub fn new() -> Self

Creates a new empty StringInterner.

pub fn with_capacity(cap: usize) -> Self

Creates a new StringInterner with the given initial capacity.

impl<S, H, const N: usize> StringInterner<S, H, N> where
    S: Symbol,
    H: BuildHasher + Clone, 

pub fn sym_to_index(sym: S) -> usize

Index in arena from Sym

pub fn sym_to_shard_index(sym: S) -> usize

Shard index from Sym

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 get_or_intern<T>(&self, val: T) -> S where
    T: Into<String> + AsRef<str>, 

Interns the given value.

Returns a symbol to access it within this interner.

This either copies the contents of the string (e.g. for str) or moves them into this interner (e.g. for String).

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

Returns the string slice associated with the given symbol if available, otherwise returns None.

pub unsafe fn resolve_unchecked(&self, symbol: S) -> Arc<str>

Returns the string associated with the given symbol.

Note

This does not check whether the given symbol has an associated string for the given string interner instance.

Safety

This will result in undefined behaviour if the given symbol had no associated string for this interner instance.

pub fn get<T>(&self, val: T) -> Option<S> where
    T: AsRef<str>, 

Returns the symbol associated with the given string for this interner if existent, otherwise returns None.

pub fn len(&self) -> usize

Returns the number of uniquely interned strings within this interner.

pub fn is_empty(&self) -> bool

Returns true if the string interner holds no elements.

pub fn shrink_to_fit(&self)

Shrinks the capacity of the interner as much as possible.

pub fn clear(&self)

Clears the StringInterner

Trait Implementations

impl<S: Debug, H: Debug, const N: usize> Debug for StringInterner<S, H, N> where
    S: Symbol,
    H: BuildHasher, 

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

Formats the value using the given formatter.

impl Default for StringInterner<Sym, RandomState, 8>

fn default() -> Self

Returns the “default value” for a type.

impl<S, H, const N: usize> Send for StringInterner<S, H, N> where
    S: Symbol + Send,
    H: BuildHasher, 

impl<S, H, const N: usize> Sync for StringInterner<S, H, N> where
    S: Symbol + Sync,
    H: BuildHasher,