pub struct OnceCell<T> { /* private fields */ }
Expand description
A cell which can be written to only once.
Unlike RefCell
, a OnceCell
only provides shared &T
references to its value.
Unlike Cell
, a OnceCell
doesn’t require copying or replacing the value to access it.
Examples
#![feature(once_cell)]
use std::lazy::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());
RunImplementations
sourceimpl<T> OnceCell<T>
impl<T> OnceCell<T>
sourcepub fn get(&self) -> Option<&T>
pub fn get(&self) -> Option<&T>
Gets the reference to the underlying value.
Returns None
if the cell is empty.
sourcepub fn get_mut(&mut self) -> Option<&mut T>
pub fn get_mut(&mut self) -> Option<&mut T>
Gets the mutable reference to the underlying value.
Returns None
if the cell is empty.
sourcepub fn set(&self, value: T) -> Result<(), T>
pub fn set(&self, value: T) -> Result<(), T>
Sets the contents of the cell to value
.
Errors
This method returns Ok(())
if the cell was empty and Err(value)
if
it was full.
Examples
#![feature(once_cell)]
use std::lazy::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());
Runsourcepub fn get_or_init<F>(&self, f: F) -> &T where
F: FnOnce() -> T,
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.
Panics
If f
panics, the panic is propagated to the caller, and the cell
remains uninitialized.
It is an error to reentrantly initialize the cell from f
. Doing
so results in a panic.
Examples
#![feature(once_cell)]
use std::lazy::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);
Runsourcepub fn get_or_try_init<F, E>(&self, f: F) -> Result<&T, E> where
F: FnOnce() -> Result<T, E>,
pub fn get_or_try_init<F, E>(&self, f: F) -> Result<&T, E> where
F: FnOnce() -> Result<T, E>,
Gets the contents of the cell, initializing it with f
if
the cell was empty. If the cell was empty and f
failed, an
error is returned.
Panics
If f
panics, the panic is propagated to the caller, and the cell
remains uninitialized.
It is an error to reentrantly initialize the cell from f
. Doing
so results in a panic.
Examples
#![feature(once_cell)]
use std::lazy::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))
Runsourcepub fn into_inner(self) -> Option<T>
pub fn into_inner(self) -> Option<T>
Consumes the cell, returning the wrapped value.
Returns None
if the cell was empty.
Examples
#![feature(once_cell)]
use std::lazy::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()));
Runsourcepub fn take(&mut self) -> Option<T>
pub fn take(&mut self) -> Option<T>
Takes the value out of this OnceCell
, moving it back to an uninitialized state.
Has no effect and returns None
if the OnceCell
hasn’t been initialized.
Safety is guaranteed by requiring a mutable reference.
Examples
#![feature(once_cell)]
use std::lazy::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);
RunTrait Implementations
impl<T: Eq> Eq for OnceCell<T>
Auto Trait Implementations
impl<T> !RefUnwindSafe for OnceCell<T>
impl<T> Send for OnceCell<T> where
T: Send,
impl<T> !Sync for OnceCell<T>
impl<T> Unpin for OnceCell<T> where
T: Unpin,
impl<T> UnwindSafe for OnceCell<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more