[−][src]Struct once_cell::sync::OnceCell
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!");
Methods
impl<T> OnceCell<T>
[src]
pub const INIT: OnceCell<T>
[src]
An empty cell, for initialization in a const
context.
pub fn new() -> OnceCell<T>
[src]
Creates a new empty cell.
pub fn get(&self) -> Option<&T>
[src]
Gets the reference to the underlying value. Returns None
if the cell is empty.
pub fn set(&self, value: T) -> Result<(), T>
[src]
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)); }
pub fn get_or_init<F: FnOnce() -> T>(&self, f: F) -> &T
[src]
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
impl<T: Send> Send for OnceCell<T>
[src]
impl<T: PartialEq> PartialEq<OnceCell<T>> for OnceCell<T>
[src]
fn eq(&self, other: &OnceCell<T>) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl<T: Sync + Send> Sync for OnceCell<T>
[src]
impl<T> Default for OnceCell<T>
[src]
impl<T> From<T> for OnceCell<T>
[src]
impl<T: Debug> Debug for OnceCell<T>
[src]
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,