53 releases (32 stable)
1.20.2 | Oct 5, 2024 |
---|---|
1.19.0 | Dec 7, 2023 |
1.18.0 | Jun 4, 2023 |
1.17.1 | Feb 14, 2023 |
0.1.6 | Sep 21, 2018 |
#8 in Rust patterns
14,953,511 downloads per month
Used in 63,903 crates
(5,992 directly)
89KB
1K
SLoC
Overview
once_cell
provides two new cell-like types, unsync::OnceCell
and sync::OnceCell
. OnceCell
might store arbitrary non-Copy
types, can be assigned to at most once and provide direct access
to the stored contents. In a nutshell, API looks roughly like this:
impl OnceCell<T> {
fn new() -> OnceCell<T> { ... }
fn set(&self, value: T) -> Result<(), T> { ... }
fn get(&self) -> Option<&T> { ... }
}
Note that, like with RefCell
and Mutex
, the set
method requires only a shared reference.
Because of the single assignment restriction get
can return an &T
instead of Ref<T>
or MutexGuard<T>
.
once_cell
also has a Lazy<T>
type, build on top of OnceCell
which provides the same API as
the lazy_static!
macro, but without using any macros:
use std::{sync::Mutex, collections::HashMap};
use once_cell::sync::Lazy;
static GLOBAL_DATA: Lazy<Mutex<HashMap<i32, String>>> = Lazy::new(|| {
let mut m = HashMap::new();
m.insert(13, "Spica".to_string());
m.insert(74, "Hoyten".to_string());
Mutex::new(m)
});
fn main() {
println!("{:?}", GLOBAL_DATA.lock().unwrap());
}
More patterns and use-cases are in the docs!
Related crates
- double-checked-cell
- lazy-init
- lazycell
- mitochondria
- lazy_static
- async_once_cell
- generic_once_cell (bring your own mutex)
Parts of once_cell
API are included into std
as of Rust 1.70.0.
Dependencies
~0–4.5MB