Struct Interner

pub struct Interner<I = u32> { /* private fields */ }

A struct responsible for efficiently interning strings

Examples

use mini_intern::Interner;
const TEST_CASE: &str = "test_case";
let mut interner = <Interner<u32>>::with_capacity(64);
_ = interner.intern("something");
_ = interner.intern("something_else");
_ = interner.intern("something_else_again");
_ = interner.intern(TEST_CASE);
assert_eq!(interner.intern(TEST_CASE), 3);

Implementations

impl<I> Interner<I>

where I: From<u32> + Copy, u32: From<I>,

pub fn with_capacity(cap: usize) -> Self

Creates an Interner with the specified capacity in memory. Useful for pre-allocating space if the size of the items to be immediately interned is known.

Examples

use mini_intern::Interner;
let interner: Interner = Interner::with_capacity(32);

pub fn intern(&mut self, name: &str) -> I

Interns the given value. If the value already exists in the interner, its ID is returned and no allocation is performed. If it does not exist, the value is interned and a new ID is created for it.

If the intern space is below the maximum capacity, no allocation occurs.

Examples

use mini_intern::Interner;
let mut interner: Interner<u32> = Interner::with_capacity(32);
interner.intern("hello");
interner.intern("and");
interner.intern("good");
interner.intern("morning");
assert_eq!(interner.intern("good"), 2u32);

pub fn lookup(&self, id: I) -> &'static str

Trait Implementations

impl<I: Debug> Debug for Interner<I>

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

Formats the value using the given formatter.