【Rust每周一库】once_cell - 最多初始化一次的cell

MikeLoveRust

发布于 2020-12-18 08:31:19

6.8K00

代码可运行

文章被收录于专栏：Rust语言学习交流Rust语言学习交流

运行总次数：0

代码可运行

once_cell提供了unsync::OnceCell和sync::OnceCell这两种Cell（字面意思，前者用于单线程，后者用于多线程），用来存储堆上的信息，并且具有最多只能赋值一次的特性。API大概是：

impl<T> OnceCell<T> {
    fn new() -> OnceCell<T> { ... }
    fn set(&self, value: T) -> Result<(), T> { ... }
    fn get(&self) -> Option<&T> { ... }
}

用法

安全的初始化全局变量

use std::{env, io};

use once_cell::sync::OnceCell;

#[derive(Debug)]
pub struct Logger {
    // ...
}
static INSTANCE: OnceCell<Logger> = OnceCell::new();

impl Logger {
    pub fn global() -> &'static Logger {
        INSTANCE.get().expect("logger is not initialized")
    }

    fn from_cli(args: env::Args) -> Result<Logger, std::io::Error> {
       // ...
    }
}

fn main() {
    let logger = Logger::from_cli(env::args()).unwrap();
    INSTANCE.set(logger).unwrap();
    // 之后就统一使用`Logger::global()`
}

Lazy产生全局变量

包中提供了Lazy，（也分sync和unsync版）可以起到类似之前提到过的lazy_static的作用——在第一次使用的时候产生一个动态的全局静态变量

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());
}

其中的好处就是不需要神奇的宏魔法了，这也是近期tokio使用它取代了之前的lazy_static的原因：https://github.com/tokio-rs/tokio/pull/3187

比起lazy_static，我们还支持局部变量

use once_cell::unsync::Lazy;

fn main() {
    let ctx = vec![1, 2, 3];
    let thunk = Lazy::new(|| {
        ctx.iter().sum::<i32>()
    });
    assert_eq!(*thunk, 6);
}

而且使用OnceCell还可以嵌入到结构体中

use std::{fs, path::PathBuf};

use once_cell::unsync::OnceCell;

struct Ctx {
    config_path: PathBuf,
    config: OnceCell<String>,
}

impl Ctx {
    pub fn get_config(&self) -> Result<&str, std::io::Error> {
        let cfg = self.config.get_or_try_init(|| {
            fs::read_to_string(&self.config_path)
        })?;
        Ok(cfg.as_str())
    }
}