#data-structures

hashlink

HashMap-like containers that hold their key-value pairs in a user controllable order

12 releases (7 breaking)

0.8.2 May 15, 2023
0.8.1 Sep 17, 2022
0.8.0 Mar 14, 2022
0.7.0 May 3, 2021
0.3.0 Jul 12, 2019

#21 in Database interfaces

Download history 179977/week @ 2023-02-04 187986/week @ 2023-02-11 187523/week @ 2023-02-18 195433/week @ 2023-02-25 193472/week @ 2023-03-04 202361/week @ 2023-03-11 206800/week @ 2023-03-18 198481/week @ 2023-03-25 184384/week @ 2023-04-01 182101/week @ 2023-04-08 193861/week @ 2023-04-15 195064/week @ 2023-04-22 184778/week @ 2023-04-29 189237/week @ 2023-05-06 195834/week @ 2023-05-13 169863/week @ 2023-05-20

770,846 downloads per month
Used in 1,184 crates (31 directly)

MIT/Apache

91KB
3K SLoC

hashlink -- HashMap-like containers that hold their key-value pairs in a user controllable order

Build Status Latest Version API Documentation

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.

Credit

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.

License

This library is licensed the same as linked-hash-map and hashbrown, it is licensed under either of:

at your option.

Dependencies

~745KB
~13K SLoC