once_map

Crates.ioonce_map
lib.rsonce_map
version0.4.21
sourcesrc
created_at2022-06-22 13:05:15.295688
updated_at2024-10-14 09:12:25.05092
descriptionSingle assignment and lazy maps
homepage
repositoryhttps://github.com/a1phyr/once_map
max_upload_size
id610850
size67,270
Alphyr (a1phyr)

documentation

https://docs.rs/once_map

README

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");
Commit count: 101

cargo fmt