#map #lazy-evaluation #once

no-std once_map

Single assignment and lazy maps

21 releases

0.4.18 May 15, 2024
0.4.15 Feb 13, 2024
0.4.13 Nov 23, 2023
0.4.6 Jun 6, 2023
0.3.1 Jul 10, 2022

#31 in Caching

Download history 565/week @ 2024-03-29 811/week @ 2024-04-05 773/week @ 2024-04-12 440/week @ 2024-04-19 281/week @ 2024-04-26 516/week @ 2024-05-03 451/week @ 2024-05-10 491/week @ 2024-05-17 756/week @ 2024-05-24 665/week @ 2024-05-31 929/week @ 2024-06-07 556/week @ 2024-06-14 626/week @ 2024-06-21 522/week @ 2024-06-28 498/week @ 2024-07-05 642/week @ 2024-07-12

2,334 downloads per month
Used in 21 crates (5 directly)

MIT/Apache

60KB
2K SLoC

once_map

Crates.io Docs.rs Minimum rustc version

This crate provides OnceMap, a type of HashMap where entries can be written with a shared reference, but can be written ony once. This is similar to once_cell, but with a map. This enables to reference values inside the map for the lifetime of the map, without the need of further locks.

This makes this type perfect for implementation of caches. A type LazyMap is provided for such cases.

This crate provides such a map heavily optimized for concurrent use, but also a single-threaded version.

Example

let map = OnceMap::new();

// All these are `&str` pointing directly in the map.
// Note that we don't need a mutable reference, so we can have several of
// them at the same time.
let roses = map.insert(String::from("rose"), |_| String::from("red"));
let violets = map.insert(String::from("violets"), |_| String::from("blue"));
let sugar = map.insert(String::from("sugar"), |_| String::from("sweet"));

assert_eq!(roses, "red");
assert_eq!(violets, "blue");
assert_eq!(sugar, "sweet");

// The closure is never run here, because we already have a value for "rose"
let roses = map.insert(String::from("rose"), |_| String::from("green"));
// The old value did not change
assert_eq!(roses, "red");

Dependencies

~1.2–8MB
~32K SLoC