Struct GlobalInterner

pub struct GlobalInterner;

Available on crate feature global only.

A global Interner, just for convenience.

GlobalInterner functions just like any other Interner, so a string interned in another interner will not be automatically interned into this one.

For most purposes, intern will be sufficient.

Methods from Deref<Target = Interner>

pub fn clear(&self)

Locks this Interner and removes all of the interned strings, or blocks until it is able to do so.

interner.clear() is equivalent to intenerer.lock().clear(). (See LockedInterner::clear.)

Panics

This method panics if this Interner has been poisoned, and it may panic if this Interner is already locked on this thread.

pub fn lock(&self) -> LockedInterner<'_, S>

Locks this Interner on the current thread until the returned LockedInterner is dropped, or blocks until it is able to do so.

While it is locked, the current thread has exclusive access to this Interner’s methods (accessible from the LockedInterner; any methods used directly on self may panic). This enables some additional functionality, most notably LockedInterner::iter.

If a panic occurs on the current thread while this Interner is locked, it will become poisoned.

Panics

This method panics if this Interner has been poisoned, and it may panic if this Interner is already locked on this thread.

pub fn intern(&self, string: impl AsRef<str>) -> InternedStr

where S: BuildHasher,

Locks this Interner, saves the given string if it is not already saved, and returns a reference to the saved allocation, or blocks until it is able to do so.

interner.intern(string) is equivalent to interner.lock().intern(string). (See LockedInterner::intern.)

Panics

This method panics if this Interner has been poisoned, and it may panic if this Interner is already locked on this thread.

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

Returns whether the given string has already been saved, or blocks until it is able to do so.

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

If the given string has already been saved, returns a reference to the saved allocation, or None otherwise, or blocks until it is able to do so.

Trait Implementations

impl Deref for GlobalInterner

type Target = Interner

The resulting type after dereferencing.

fn deref(&self) -> &Interner

Dereferences the value.