58 releases (37 stable)

1.21.3 Mar 28, 2025
1.20.3 Feb 6, 2025
1.20.2 Oct 5, 2024
1.19.0 Dec 7, 2023
0.1.6 Sep 21, 2018

#5 in Rust patterns

Download history 4002339/week @ 2025-01-11 3821611/week @ 2025-01-18 4234405/week @ 2025-01-25 4591746/week @ 2025-02-01 5032927/week @ 2025-02-08 4965258/week @ 2025-02-15 5107355/week @ 2025-02-22 5204733/week @ 2025-03-01 5490314/week @ 2025-03-08 5881423/week @ 2025-03-15 5968839/week @ 2025-03-22 5669287/week @ 2025-03-29 5949153/week @ 2025-04-05 5463651/week @ 2025-04-12 5362373/week @ 2025-04-19 5315759/week @ 2025-04-26

23,023,111 downloads per month
Used in 72,608 crates (6,295 directly)

MIT/Apache

92KB
1K SLoC

once_cell

Build Status Crates.io API reference

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

Parts of once_cell API are included into std as of Rust 1.70.0.

Dependencies

~0–5MB