commit	ab0d2f857ded6a09bcbc3d95d0d803304b01ef63	[log] [tgz]
author	android-build-team Robot <android-build-team-robot@google.com>	Sun Feb 21 00:05:20 2021 +0000
committer	android-build-team Robot <android-build-team-robot@google.com>	Sun Feb 21 00:05:20 2021 +0000
tree	6e7343b6e19bf6a035fc087285e5cbbc291b9bdb
parent	341f59d478a1af88c0baff577346caacf52078c8 [diff]
parent	08fa36f70e174e5866d455a970ddb1b7e38a8b24 [diff]

tree: 6e7343b6e19bf6a035fc087285e5cbbc291b9bdb

README.md

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

The API of once_cell is being proposed for inclusion in std.