Trait string_interner::backend::Backend[−][src]

pub trait Backend<S>: Default where
    S: Symbol, {
    fn with_capacity(cap: usize) -> Self;
    fn intern(&mut self, string: &str) -> S;
    fn shrink_to_fit(&mut self);
    fn resolve(&self, symbol: S) -> Option<&str>;
    unsafe fn resolve_unchecked(&self, symbol: S) -> &str;

    fn intern_static(&mut self, string: &'static str) -> S { ... }
}

Expand description

Types implementing this trait may act as backends for the string interner.

The job of a backend is to actually store, manage and organize the interned strings. Different backends have different trade-offs. Users should pick their backend with hinsight of their personal use-case.

Required methods

[src]

fn with_capacity(cap: usize) -> Self

Creates a new backend for the given capacity.

The capacity denotes how many strings are expected to be interned.

[src]

fn intern(&mut self, string: &str) -> S

Interns the given string and returns its interned ref and symbol.

Note

The backend must make sure that the returned symbol maps back to the original string in its resolve method.

[src]

fn shrink_to_fit(&mut self)

Shrink backend capacity to fit interned symbols exactly.

[src]

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

Resolves the given symbol to its original string contents.

[src]

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

Resolves the given symbol to its original string contents.

Safety

Does not perform validity checks on the given symbol and relies on the caller to be provided with a symbol that has been generated by the intern or intern_static methods of the same interner backend.