Struct LazyWrap

pub struct LazyWrap<T, F = fn() -> T> { /* private fields */ }

A lazily initialised data wrapper that initialises itself on first access

Implementations

impl<T, F> LazyWrap<T, F>

where F: FnOnce() -> T,

pub const fn new(init: F) -> Self

Creates a new uninitialised instance that will be initialised with the provided initialisation function.

pub fn ensure_initialised(this: &Self)

Runs initialisation if the value is not initialised yet, and blocks until it is complete.

Note: Deref and DerefMut automatically initialise if necessary.

pub fn is_initialised(this: &Self) -> bool

Returns true or false, depending on if the value is initialised.

Panics

Panics if the provided initialisation function panicked.

pub fn into_inner(this: Self) -> LazyWrapState<T, F>

Fetch the value if its initialised, or return the initialisation function if it isn’t.

pub fn into_inner_initialised(this: Self) -> T

Ensures that the value is initialised, then returns the value.

Trait Implementations

impl<T, U, F> AsMut<U> for LazyWrap<T, F>

where F: FnOnce() -> T, T: AsMut<U>, U: ?Sized,

fn as_mut(&mut self) -> &mut U

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, U, F> AsRef<U> for LazyWrap<T, F>

where F: FnOnce() -> T, T: AsRef<U>, U: ?Sized,

fn as_ref(&self) -> &U

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, F> Debug for LazyWrap<T, F>

where T: Debug, F: FnOnce() -> T,

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

Formats the value using the given formatter.

impl<T, F> Deref for LazyWrap<T, F>

where F: FnOnce() -> T,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, F> DerefMut for LazyWrap<T, F>

where F: FnOnce() -> T,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, F> Display for LazyWrap<T, F>

where T: Display, F: FnOnce() -> T,

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

Formats the value using the given formatter.

impl<T, F> Drop for LazyWrap<T, F>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, F> RefUnwindSafe for LazyWrap<T, F>

where T: RefUnwindSafe, F: UnwindSafe,

impl<T, F> Send for LazyWrap<T, F>

where T: Send, F: Send,

impl<T, F> Sync for LazyWrap<T, F>

where T: Sync, F: Send,

impl<T, F> Unpin for LazyWrap<T, F>

where T: Unpin, F: Unpin,

impl<T, F> UnwindSafe for LazyWrap<T, F>

where T: UnwindSafe, F: UnwindSafe,