Skip to main content

Once

Struct Once 

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

A minimal, spin-based Once initializer.

This type is useful for global singletons in no_std environments. It supports one-time initialization with call_once.

§State machine

  • 0: uninitialized
  • 1: initialization in progress
  • 2: initialized

Implementations§

Source§

impl<T> Once<T>

Source

pub const fn new() -> Self

Creates a new uninitialized cell.

Source

pub fn is_initialized(&self) -> bool

Returns true if the value has been initialized.

Source

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

Returns a reference to the value if initialized.

Source

pub fn call_once(&self, init: impl FnOnce() -> T) -> &T

Initializes the cell with init at most once and returns a reference to the stored value.

If another core is currently initializing, this method will spin until initialization completes.

Trait Implementations§

Source§

impl<T> Default for Once<T>

Source§

fn default() -> Self

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

impl<T: Send> Send for Once<T>

Source§

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

Auto Trait Implementations§

§

impl<T> !Freeze for Once<T>

§

impl<T> !RefUnwindSafe for Once<T>

§

impl<T> Unpin for Once<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Once<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Once<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<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.