pub struct OnceLock<T> { /* private fields */ }
Expand description
只能写入一次的同步原语。
此类型是线程安全的 OnceCell
,可用于静态。
Examples
use std::sync::OnceLock;
static CELL: OnceLock<String> = OnceLock::new();
assert!(CELL.get().is_none());
std::thread::spawn(|| {
let value: &String = CELL.get_or_init(|| {
"Hello, World!".to_string()
});
assert_eq!(value, "Hello, World!");
}).join().unwrap();
let value: Option<&String> = CELL.get();
assert!(value.is_some());
assert_eq!(value.unwrap().as_str(), "Hello, World!");
RunImplementations§
source§impl<T> OnceLock<T>
impl<T> OnceLock<T>
sourcepub fn set(&self, value: T) -> Result<(), T>
pub fn set(&self, value: T) -> Result<(), T>
将此 cell 的内容设置为 value
。
如果另一个线程当前正在尝试初始化该 cell,则可能会阻塞。 尽管 set 不一定返回,但保证该 cell 包含一个值。
如果此调用设置了 cell 的值,则返回 Ok(())
。
Examples
use std::sync::OnceLock;
static CELL: OnceLock<i32> = OnceLock::new();
fn main() {
assert!(CELL.get().is_none());
std::thread::spawn(|| {
assert_eq!(CELL.set(92), Ok(()));
}).join().unwrap();
assert_eq!(CELL.set(62), Err(62));
assert_eq!(CELL.get(), Some(&92));
}
Runsourcepub fn get_or_init<F>(&self, f: F) -> &Twhere
F: FnOnce() -> T,
pub fn get_or_init<F>(&self, f: F) -> &Twhere F: FnOnce() -> T,
获取 cell 的内容,如果 cell 为空,则使用 f
对其进行初始化。
许多线程可以使用不同的初始化函数并发调用 get_or_init
,但是可以保证仅执行一个函数。
Panics
如果 f
panics,则 panic 会传播给调用者,并且 cell 仍保持未初始化状态。
重新从 f
初始化 cell 是错误的。确切的结果是不确定的。
当前的实现死锁,但是可以在 future 中将其更改为 panic。
Examples
use std::sync::OnceLock;
let cell = OnceLock::new();
let value = cell.get_or_init(|| 92);
assert_eq!(value, &92);
let value = cell.get_or_init(|| unreachable!());
assert_eq!(value, &92);
Runsourcepub fn get_or_try_init<F, E>(&self, f: F) -> Result<&T, E>where
F: FnOnce() -> Result<T, E>,
🔬This is a nightly-only experimental API. (once_cell_try
#109737)
pub fn get_or_try_init<F, E>(&self, f: F) -> Result<&T, E>where F: FnOnce() -> Result<T, E>,
once_cell_try
#109737)获取 cell 的内容,如果 cell 为空,则使用 f
对其进行初始化。
如果 cell 为空并且 f
失败,则返回错误。
Panics
如果 f
panics,则 panic 会传播给调用者,并且 cell 仍保持未初始化状态。
重新从 f
初始化 cell 是错误的。
确切的结果是不确定的。
当前的实现死锁,但是可以在 future 中将其更改为 panic。
Examples
#![feature(once_cell_try)]
use std::sync::OnceLock;
let cell = OnceLock::new();
assert_eq!(cell.get_or_try_init(|| Err(())), Err(()));
assert!(cell.get().is_none());
let value = cell.get_or_try_init(|| -> Result<i32, ()> {
Ok(92)
});
assert_eq!(value, Ok(&92));
assert_eq!(cell.get(), Some(&92))
Runsourcepub fn into_inner(self) -> Option<T>
pub fn into_inner(self) -> Option<T>
sourcepub fn take(&mut self) -> Option<T>
pub fn take(&mut self) -> Option<T>
从此 OnceLock
中取出值,将其移回未初始化状态。
如果 OnceLock
尚未初始化,则无效并返回 None
。
通过要求可变引用来保证安全。
Examples
use std::sync::OnceLock;
let mut cell: OnceLock<String> = OnceLock::new();
assert_eq!(cell.take(), None);
let mut cell = OnceLock::new();
cell.set("hello".to_string()).unwrap();
assert_eq!(cell.take(), Some("hello".to_string()));
assert_eq!(cell.get(), None);
RunTrait Implementations§
impl<T: Eq> Eq for OnceLock<T>
impl<T: RefUnwindSafe + UnwindSafe> RefUnwindSafe for OnceLock<T>
impl<T: Send> Send for OnceLock<T>
impl<T: Sync + Send> Sync for OnceLock<T>
impl<T: UnwindSafe> UnwindSafe for OnceLock<T>
Auto Trait Implementations§
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
从拥有的值中借用。 Read more