Struct intern_arc::OrdInterner

pub struct OrdInterner<T: ?Sized + Ord> { /* fields omitted */ }

Interner for values with a total order

The interner is cheaply cloneable by virtue of keeping the underlying storage in an Arc. Once the last reference to this interner is dropped, it will clear its backing storage and release all references to the interned values it has created that are still live. Those values remain fully operational until dropped. Memory for the values themselves is freed for each value individually once its last reference is dropped. The interner’s ArcInner memory will only be deallocated once the last interned value has been dropped (this is less than hundred bytes).

Implementations

impl<T: ?Sized + Ord> OrdInterner<T>

pub fn new() -> Self

pub fn len(&self) -> usize

Returns the number of objects currently kept in this interner.

pub fn is_empty(&self) -> bool

Returns true when this interner doesn’t hold any values.

pub fn intern_ref(&self, value: &T) -> InternedOrd<T> where
    T: ToOwned,
    T::Owned: Into<Box<T>>, 

Intern a value from a shared reference by allocating new memory for it.

use intern_arc::{OrdInterner, InternedOrd};

let strings = OrdInterner::<str>::new();
let i: InternedOrd<str> = strings.intern_ref("hello world!");

pub fn intern_box(&self, value: Box<T>) -> InternedOrd<T>

Intern a value from an owned reference without allocating new memory for it.

use intern_arc::{OrdInterner, InternedOrd};

let strings = OrdInterner::<str>::new();
let hello: Box<str> = "hello world!".into();
let i: InternedOrd<str> = strings.intern_box(hello);

(This also works nicely with a String that can be turned .into() a Box.)

pub fn intern_sized(&self, value: T) -> InternedOrd<T> where
    T: Sized, 

Intern a sized value, allocating heap memory for it.

use intern_arc::{OrdInterner, InternedOrd};

let arrays = OrdInterner::<[u8; 1000]>::new();
let i: InternedOrd<[u8; 1000]> = arrays.intern_sized([0; 1000]);

Trait Implementations

impl<T: ?Sized + Ord> Clone for OrdInterner<T>

fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: ?Sized + Ord> Default for OrdInterner<T>

fn default() -> Self

Returns the “default value” for a type.