Struct once_cell::race::OnceBox

source ·
pub struct OnceBox<T> {
    inner: AtomicPtr<T>,
    ghost: PhantomData<Option<Box<T>>>,
}
Expand description

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

Fields§

§inner: AtomicPtr<T>§ghost: PhantomData<Option<Box<T>>>

Implementations§

source§

impl<T> OnceBox<T>

source

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

Creates a new empty cell.

source

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

Gets a reference to the underlying value.

source

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

Sets the contents of this cell to value.

Returns Ok(()) if the cell was empty and Err(value) if it was full.

source

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

Gets the contents of the cell, initializing it with f if the cell was empty.

If several threads concurrently run get_or_init, more than one f can be called. However, all threads will return the same value, produced by some f.

source

pub fn get_or_try_init<F, E>(&self, f: F) -> Result<&T, E>
where F: FnOnce() -> Result<Box<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.

If several threads concurrently run get_or_init, more than one f can be called. However, all threads will return the same value, produced by some f.

Trait Implementations§

source§

impl<T> Debug for OnceBox<T>

source§

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

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

impl<T> Default for OnceBox<T>

source§

fn default() -> Self

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

impl<T> Drop for OnceBox<T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<T: Sync + Send> Sync for OnceBox<T>

Auto Trait Implementations§

§

impl<T> !Freeze for OnceBox<T>

§

impl<T> RefUnwindSafe for OnceBox<T>
where T: RefUnwindSafe,

§

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

§

impl<T> Unpin for OnceBox<T>

§

impl<T> UnwindSafe for OnceBox<T>

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<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>,

§

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>,

§

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.