Struct OnceCell

Source
pub struct OnceCell<T> { /* private fields */ }
Expand description

A thread-safe cell which can be written to only once.

Unlike ::std::sync::Mutex, a OnceCell provides simple & references to the contents.

§Example

use once_cell::sync::OnceCell;

static CELL: OnceCell<String> = OnceCell::INIT;
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!");

Implementations§

Source§

impl<T> OnceCell<T>

Source

pub const INIT: OnceCell<T>

An empty cell, for initialization in a const context.

Source

pub fn new() -> OnceCell<T>

Creates a new empty cell.

Source

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

Gets the reference to the underlying value. Returns None if the cell is empty.

Source

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

Sets the contents of this cell to value. Returns Ok(()) if the cell was empty and Err(value) if it was full.

§Example
use once_cell::sync::OnceCell;

static CELL: OnceCell<i32> = OnceCell::INIT;

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

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

Gets the contents of the cell, initializing it with f if the cell was empty. May threads may call get_or_init concurrently with different initializing functions, but it is guaranteed that only one function will be executed.

§Example
use once_cell::sync::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);

Trait Implementations§

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for OnceCell<T>

Source§

fn default() -> OnceCell<T>

Returns the “default value” for a type. Read more
Source§

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

Source§

fn from(value: T) -> OnceCell<T>

Converts to this type from the input type.
Source§

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

Source§

fn eq(&self, other: &OnceCell<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

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

Auto Trait Implementations§

§

impl<T> !Freeze for OnceCell<T>

§

impl<T> !RefUnwindSafe for OnceCell<T>

§

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 T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<!> for T

Source§

fn from(t: !) -> T

Converts to this type from the input type.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.