commit | 3cf8848f1d692a1797373109ef0ae262691c8390 | [log] [tgz] |
---|---|---|
author | Daniel Norman <danielnorman@google.com> | Mon Nov 30 11:41:53 2020 -0800 |
committer | Daniel Norman <danielnorman@google.com> | Mon Nov 30 11:41:53 2020 -0800 |
tree | 50069180fea404c5247eb6b933c6836cda6f2857 | |
parent | f9571b675554e0cc4c2a37e68df0b78a40f5c027 [diff] | |
parent | 089f3fbe1fd856ef719a2355b5e52e0e402e287e [diff] |
Merge SP1A.201130.001 Change-Id: I402c99843e1f50665e2aedde5ffbccb27a5c0b10
This crate is a fork of linked-hash-map that builds on top of hashbrown to implement more up to date versions of LinkedHashMap
LinkedHashSet
, and LruCache
.
One important API change is that when a LinkedHashMap
is used as a LRU cache, it allows you to easily retrieve an entry and move it to the back OR produce a new entry at the back without needlessly repeating key hashing and lookups:
let mut lru_cache = LinkedHashMap::new(); let key = "key".to_owned(); // Try to find my expensive to construct and hash key let _cached_val = match lru_cache.raw_entry_mut().from_key(&key) { RawEntryMut::Occupied(mut occupied) => { // Cache hit, move entry to the back. occupied.to_back(); occupied.into_mut() } RawEntryMut::Vacant(vacant) => { // Insert expensive to construct key and expensive to compute value, // automatically inserted at the back. vacant.insert(key.clone(), 42).1 } };
Or, a simpler way to do the same thing:
let mut lru_cache = LinkedHashMap::new(); let key = "key".to_owned(); let _cached_val = lru_cache .raw_entry_mut() .from_key(&key) .or_insert_with(|| (key.clone(), 42));
This crate contains a decent amount of unsafe code from handling its internal linked list, and the unsafe code has diverged quite a lot from the original linked-hash-map
implementation. It currently passes tests under miri and sanitizers, but it should probably still receive more review and testing, and check for test code coverage.
There is a huge amount of code in this crate that is copied verbatim from linked-hash-map
and hashbrown
, especially tests, associated types like iterators, and things like Debug
impls.
This library is licensed the same as linked-hash-map and hashbrown, it is licensed under either of:
at your option.