#no-std #order #key

no-std hashlink

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

17 releases (9 breaking)

0.10.0 Dec 9, 2024
0.9.1 May 12, 2024
0.9.0 Jan 9, 2024
0.8.4 Aug 28, 2023
0.3.0 Jul 12, 2019

#14 in Data structures

Download history 961180/week @ 2025-01-28 1082203/week @ 2025-02-04 1103577/week @ 2025-02-11 1232643/week @ 2025-02-18 1314257/week @ 2025-02-25 1718018/week @ 2025-03-04 1602025/week @ 2025-03-11 1977350/week @ 2025-03-18 1772678/week @ 2025-03-25 1454400/week @ 2025-04-01 1444867/week @ 2025-04-08 1158021/week @ 2025-04-15 1245870/week @ 2025-04-22 1149039/week @ 2025-04-29 1275673/week @ 2025-05-06 1046434/week @ 2025-05-13

4,885,335 downloads per month
Used in 3,519 crates (78 directly)

MIT/Apache

99KB
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

~520–790KB
~12K SLoC