8 releases (4 breaking)
|0.5.0||Jul 16, 2020|
|0.4.2||Jul 16, 2020|
|0.4.1||May 17, 2020|
|0.3.0||May 17, 2020|
|0.1.0||Apr 24, 2020|
#233 in Algorithms
3,696 downloads per month
Used in internment
This crate is a fork of David Roundy's
It provides an alternative implementation of the
type. It inherits David's high-level design and API; however it is built
completely on Rust's standard
Arc type and the
dashmap crate and does not contain
any unsafe code.
Interning reduces the memory footprint of an application by storing a unique copy of each distinct value. It speeds up equality comparison and hashing operations, as only pointers rather than actual values need to be compared. On the flip side, object creation is slower, as it involves lookup in the interned object pool.
Interning is most commonly applied to strings; however it can also be useful for other object types. This library supports interning of arbitrary objects.
There exist several interning libraries for Rust, each with its own set of tradeoffs. This library makes the following design choices:
- Interned objects are reference counted. When the last reference to an interned object is dropped, the object is deallocated. This prevents unbounded growth of the interned object pool in applications where the set of interned values changes dynamically at the cost of some CPU and memory overhead (due to storing and maintaining an atomic counter).
- Multithreading. A single pool of interned objects is shared by all
threads in the program. The pool is implemented as a
DashMapfor safe concurrent access and low contention.
- Not just strings: this library allows interning any data type that
Eq + Hash + Send + Synctrait bound.
- Safe: this library is built on
DashMaptypes and does not contain any unsafe code.
use arc_interner::ArcIntern; let x = ArcIntern::new("hello"); let y = ArcIntern::new("world"); assert_ne!(x, y); assert_eq!(x, ArcIntern::new("hello")); assert_eq!(*x, "hello"); // dereference an ArcIntern like a pointer