Struct InitOnce

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

Lazily initialize a value of some arbitrary type T. Reading the value doesn’t block the caller, if it is being initialized concurrently.

Implementations§

Source§

impl<T> InitOnce<T>

Source

pub const fn new() -> Self

Create an uninitialized InitOnce.

Source

pub fn state(&self) -> InitState<'_, T>

Query the state of an InitOnce instance.

If the current state is InitState::Polling, the caller is responsible for polling the init function to completion.

Source

pub fn try_init<F>(&self, init: F) -> Option<&T>
where F: FnMut() -> T,

Attempt to initialize this InitOnce with the value returned by the closure init.

Source

pub async fn try_init_async<F>(&self, init: F) -> Option<&T>
where F: Future<Output = T>,

Attempt to initialize this InitOnce with the value returned by the future init.

Source

pub fn init<F>(&mut self, init: F) -> &mut T
where F: FnMut() -> T,

Initialize this InitOnce with the value returned by the closure init.

Source

pub async fn init_async<F>(&mut self, init: F) -> &mut T
where F: Future<Output = T>,

Initialize this InitOnce with the value returned by the future init.

Trait Implementations§

Source§

impl<T: Debug> Debug for InitOnce<T>

Source§

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

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

impl<T> Default for InitOnce<T>

Source§

fn default() -> Self

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

impl<T> Drop for InitOnce<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<T: Sync> Sync for InitOnce<T>

Auto Trait Implementations§

§

impl<T> !Freeze for InitOnce<T>

§

impl<T> !RefUnwindSafe for InitOnce<T>

§

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

§

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

§

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