Struct core::cell::OnceCell

1.70.0 · source ·
pub struct OnceCell<T> { /* private fields */ }
Expand description

一个 cell 只能写入一次。

这允许在不复制或替换它的情况下获取共享的 &T 引用其内部值 (与 Cell 不同),并且无需运行时引用检查 (与 RefCell 不同)。

但是,除非对 cell 本身具有可变引用,否则只能获得不可更改引用。

有关此结构体的线程安全版本,请参见 std::sync::OnceLock

Examples

use std::cell::OnceCell;

let cell = OnceCell::new();
assert!(cell.get().is_none());

let value: &String = cell.get_or_init(|| {
    "Hello, World!".to_string()
});
assert_eq!(value, "Hello, World!");
assert!(cell.get().is_some());
Run

Implementations§

source§

impl<T> OnceCell<T>

const: 1.70.0 · source

pub const fn new() -> OnceCell<T>

创建一个新的空 cell。

source

pub fn get(&self) -> Option<&T>

获取对底层值的引用。

如果 cell 为空,则返回 None

source

pub fn get_mut(&mut self) -> Option<&mut T>

获取对底层值的可变引用。

如果 cell 为空,则返回 None

source

pub fn set(&self, value: T) -> Result<(), T>

将 cell 的内容设置为 value

Errors

如果 cell 为空,则此方法返回 Ok(()); 如果 cell 已满,则返回 Err(value)

Examples
use std::cell::OnceCell;

let cell = OnceCell::new();
assert!(cell.get().is_none());

assert_eq!(cell.set(92), Ok(()));
assert_eq!(cell.set(62), Err(62));

assert!(cell.get().is_some());
Run
source

pub fn get_or_init<F>(&self, f: F) -> &Twhere F: FnOnce() -> T,

获取 cell 的内容,如果 cell 为空,则使用 f 对其进行初始化。

Panics

如果 f panics,则 panic 会传播给调用者,并且 cell 仍保持未初始化状态。

重新从 f 初始化 cell 是错误的。这样做会导致 panic。

Examples
use std::cell::OnceCell;

let cell = OnceCell::new();
let value = cell.get_or_init(|| 92);
assert_eq!(value, &92);
let value = cell.get_or_init(|| unreachable!());
assert_eq!(value, &92);
Run
source

pub 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)

获取 cell 的内容,如果 cell 为空,则使用 f 对其进行初始化。 如果 cell 为空并且 f 失败,则返回错误。

Panics

如果 f panics,则 panic 会传播给调用者,并且 cell 仍保持未初始化状态。

重新从 f 初始化 cell 是错误的。这样做会导致 panic。

Examples
#![feature(once_cell_try)]

use std::cell::OnceCell;

let cell = OnceCell::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))
Run
source

pub fn into_inner(self) -> Option<T>

消费 cell,返回包装后的值。

如果 cell 为空,则返回 None

Examples
use std::cell::OnceCell;

let cell: OnceCell<String> = OnceCell::new();
assert_eq!(cell.into_inner(), None);

let cell = OnceCell::new();
cell.set("hello".to_string()).unwrap();
assert_eq!(cell.into_inner(), Some("hello".to_string()));
Run
source

pub fn take(&mut self) -> Option<T>

OnceCell 中取出值,将其移回未初始化状态。

无效,如果尚未初始化 OnceCell,则返回 None

通过要求可变引用来保证安全。

Examples
use std::cell::OnceCell;

let mut cell: OnceCell<String> = OnceCell::new();
assert_eq!(cell.take(), None);

let mut cell = OnceCell::new();
cell.set("hello".to_string()).unwrap();
assert_eq!(cell.take(), Some("hello".to_string()));
assert_eq!(cell.get(), None);
Run

Trait Implementations§

source§

impl<T: Clone> Clone for OnceCell<T>

source§

fn clone(&self) -> OnceCell<T>

返回值的副本。 Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

source 执行复制分配。 Read more
source§

impl<T: Debug> Debug for OnceCell<T>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

使用给定的格式化程序格式化该值。 Read more
source§

impl<T> Default for OnceCell<T>

source§

fn default() -> Self

返回类型的 “默认值”。 Read more
source§

impl<T> From<T> for OnceCell<T>

source§

fn from(value: T) -> Self

创建一个已经包含给定 value 的新 OnceCell<T>

source§

impl<T: PartialEq> PartialEq<OnceCell<T>> for OnceCell<T>

source§

fn eq(&self, other: &Self) -> bool

此方法测试 selfother 值是否相等,并由 == 使用。
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

此方法测试 !=。 默认实现几乎总是足够的,并且不应在没有充分理由的情况下被覆盖。
source§

impl<T: Eq> Eq for OnceCell<T>

source§

impl<T> !Sync for OnceCell<T>

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for OnceCell<T>

§

impl<T> Send for OnceCell<T>where T: Send,

§

impl<T> Unpin for OnceCell<T>where T: Unpin,

§

impl<T> UnwindSafe for OnceCell<T>where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

获取 selfTypeIdRead more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

从拥有的值中一成不变地借用。 Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

从拥有的值中借用。 Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

从输入类型转换为此类型。
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

返回未更改的参数。

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

调用 U::from(self)

也就是说,这种转换是 From<T> for U 实现选择执行的任何操作。

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

发生转换错误时返回的类型。
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

执行转换。
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

发生转换错误时返回的类型。
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

执行转换。