结构体 SetOnce

Source

pub struct SetOnce<T> { /* private fields */ }

展开描述

一个线程安全的 cell，只能写入一次。

SetOnce 的灵感来自 python 的 asyncio.Event 类型。它可用于等待直到 SetOnce 的值被设置，类似于 “Event” 机制。

§Example

use tokio::sync::{SetOnce, SetOnceError};







static ONCE: SetOnce<u32> = SetOnce::const_new();











// set the value inside a task somewhere...



tokio::spawn(async move { ONCE.set(20) });







// checking with .get doesn't block main thread



println!("{:?}", ONCE.get());







// wait until the value is set, blocks the thread



println!("{:?}", ONCE.wait().await);







Ok(())

SetOnce 通常用于在首次使用时需要初始化一次，但不需要进一步更改的全局变量。 Tokio 中的 SetOnce 允许初始化过程是异步的。

§Example

use tokio::sync::{SetOnce, SetOnceError};



use std::sync::Arc;







let once = SetOnce::new();







let arc = Arc::new(once);



let first_cl = Arc::clone(&arc);



let second_cl = Arc::clone(&arc);







// set the value inside a task



tokio::spawn(async move { first_cl.set(20) }).await.unwrap()?;







// wait inside task to not block the main thread



tokio::spawn(async move {



    // wait inside async context for the value to be set



    assert_eq!(*second_cl.wait().await, 20);



}).await.unwrap();







// subsequent set calls will fail



assert!(arc.set(30).is_err());







println!("{:?}", arc.get());







Ok(())

实现§

Source §

impl<T> SetOnce<T>

Source

pub fn new() -> Self

创建一个新的空 SetOnce 实例。

Source

pub const fn const_new() -> Self

创建一个新的空 SetOnce 实例。

与 SetOnce::new 等价，但可用于静态变量中。

使用 tracing 不稳定特性时，通过 const_new 创建的 SetOnce 不会被插桩。因此，它不会出现在 tokio-console 中。如有需要，请改用 SetOnce::new 来创建可插桩的对象。

§Example

use tokio::sync::{SetOnce, SetOnceError};







static ONCE: SetOnce<u32> = SetOnce::const_new();







fn get_global_integer() -> Result<Option<&'static u32>, SetOnceError<u32>> {



    ONCE.set(2)?;



    Ok(ONCE.get())



}







let result = get_global_integer()?;







assert_eq!(result, Some(&2));



Ok(())

Source

pub fn new_with(value: Option<T>) -> Self

创建一个包含所提供值（如果有）的新的 SetOnce。

如果 Option 是 None，则等价于 SetOnce::new。

Source

pub const fn const_new_with(value: T) -> Self

创建一个包含所提供值的新的 SetOnce。

§Example

使用 tracing 不稳定特性时，通过 const_new_with 创建的 SetOnce 不会被插桩。因此，它不会出现在 tokio-console 中。如有需要，请改用 SetOnce::new_with 来创建可插桩的对象。

use tokio::sync::SetOnce;







static ONCE: SetOnce<u32> = SetOnce::const_new_with(1);







fn get_global_integer() -> Option<&'static u32> {



    ONCE.get()



}







let result = get_global_integer();







assert_eq!(result, Some(&1));