Enum SetResult

pub enum SetResult<'once_cell, T> {
    Ok(&'once_cell T),
    Initializing(T),
    Initialized(&'once_cell T, T),
}

The return value of OnceCell::set.

Variants

Ok(&'once_cell T)

The cell was succesfully initialized. Contains a reference to the new inner value.

Initializing(T)

The cell was in the process of being initialized by another task, and so could not be set. Contains the value passed into OnceCell::set.

Initialized(&'once_cell T, T)

The cell was already initialized. Contains both a reference to the initialized value and the value passed into set.

Implementations

impl<'once_cell, T> SetResult<'once_cell, T>

pub fn ok(self) -> Result<&'once_cell T, T>

Get a Result over whether the given value was successfully inserted into the cell.

pub fn value(&self) -> Option<&'once_cell T>

Retrieve a shared reference to the value inside the OnceCell if one was present.

pub fn unwrap(self) -> &'once_cell T

Panic if setting the value failed (the OnceCell was being initialized or not empty).

Trait Implementations

impl<'once_cell, T: Clone> Clone for SetResult<'once_cell, T>

fn clone(&self) -> SetResult<'once_cell, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'once_cell, T: Debug> Debug for SetResult<'once_cell, T>

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

Formats the value using the given formatter.

impl<'once_cell, T: PartialEq> PartialEq for SetResult<'once_cell, T>

fn eq(&self, other: &SetResult<'once_cell, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'once_cell, T: Copy> Copy for SetResult<'once_cell, T>

impl<'once_cell, T: Eq> Eq for SetResult<'once_cell, T>

impl<'once_cell, T> StructuralPartialEq for SetResult<'once_cell, T>