Struct StringPool 

pub struct StringPool { /* private fields */ }

A pool of interned strings.

Insert new strings with StringPool::insert to get an Atom that is unique per string within the context of the associated pool.

Once you have interned a string into the pool and have its Atom, you can get the interned string slice via &pool[atom] or pool.get(atom).

In general, there are no correctness protections against indexing into a different StringPool from the one that the Atom was not allocated inside. Doing so is memory safe but may panic or otherwise return incorrect results.

Implementations

impl StringPool

pub fn new() -> Self

Create a new, empty pool.

pub fn insert(&mut self, s: &str) -> Result<Atom, OutOfMemory>

Insert a new string into this pool.

pub fn get_atom(&self, s: &str) -> Option<Atom>

Get the Atom for the given string, if it has already been inserted into this pool.

pub fn contains(&self, atom: Atom) -> bool

Does this pool contain the given atom?

pub fn get(&self, atom: Atom) -> Option<&str>

Get the string associated with the given atom, if the pool contains the atom.

pub fn len(&self) -> usize

Get the number of strings in this pool.

Trait Implementations

impl Debug for StringPool

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

Formats the value using the given formatter.

impl Default for StringPool

fn default() -> StringPool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StringPool

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for StringPool

fn drop(&mut self)

Executes the destructor for this type.

impl Index<&Atom> for StringPool

type Output = str

The returned type after indexing.

fn index(&self, atom: &Atom) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Atom> for StringPool

type Output = str

The returned type after indexing.

fn index(&self, atom: Atom) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Serialize for StringPool

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryClone for StringPool

fn try_clone(&self) -> Result<Self, OutOfMemory>

Attempt to clone self, returning an error if any allocation fails during cloning.