Struct static_init::LockedLazy

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

A mutable locked lazy that initialize its content on the first lock

Implementations

impl<T, G> LockedLazy<T, G>

where G: Generator<T>,

pub fn phase(&self) -> Phase

Returns the current phase and synchronize with the end of the transition to the returned phase.

impl<T, G> LockedLazy<T, G>

where G: Generator<T>,

pub fn read(&self) -> ReadGuard<'_, T>

Initialize if necessary and returns a read lock

Panic

Panics if initialization panics or if initialization has panicked in a previous attempt to initialize.

pub fn fast_read(&self) -> Option<ReadGuard<'_, T>>

Initialize if necessary and returns some read lock if the lazy is not already write locked. If the lazy is already write locked it returns None

Panic

If locks succeeds, panics if initialization panics or if initialization has panicked in a previous attempt to initialize.

pub fn try_read(&self) -> Result<ReadGuard<'_, T>, AccessError>

Get a read lock if the lazy is initialized or an AccessError

pub fn fast_try_read(&self) -> Option<Result<ReadGuard<'_, T>, AccessError>>

if the lazy is not already write locked: get a read lock if the lazy is initialized or an AccessError. Otherwise returns None

pub fn write(&self) -> WriteGuard<'_, T>

Initialize if necessary and returns a write lock

Panic

Panics if initialization panics or if initialization has panicked in a previous attempt to initialize.

pub fn fast_write(&self) -> Option<WriteGuard<'_, T>>

Initialize if necessary and returns some write lock if the lazy is not already write locked. If the lazy is already read or write locked it returns None

Panic

If locks succeeds, panics if initialization panics or if initialization has panicked in a previous attempt to initialize.

pub fn try_write(&self) -> Result<WriteGuard<'_, T>, AccessError>

Get a read lock if the lazy is initialized or an AccessError

pub fn fast_try_write(&self) -> Option<Result<WriteGuard<'_, T>, AccessError>>

if the lazy is not already read or write locked: get a write lock if the lazy is initialized or an AccessError . Otherwise returns None

pub fn init(&self)

Initialize the lazy if no previous attempt to initialized it where performed

impl<T, G> LockedLazy<T, G>

pub const fn from_generator(f: G) -> Self

Build a new static object.

Safety

This function may be unsafe if build this object as anything else than a static or a thread local static would be the cause of undefined behavior

pub const fn from_generator_with_info(f: G, info: StaticInfo) -> Self

Build a new static object with debug informations.

Safety

This function may be unsafe if build this object as anything else than a static or a thread local static would be the cause of undefined behavior

impl<T, G> LockedLazy<T, Cell<Option<G>>>

where G: FnOnce() -> T,

pub fn new(g: G) -> Self

impl<T: Send, G: Generator<T>> LockedLazy<T, G>

pub fn get_mut(&mut self) -> &mut T

Initialize and return a mutable reference to the target

This method is extremly efficient as it does not requires any form of locking when initializing

pub fn try_get_mut(&mut self) -> Result<&mut T, AccessError>

Return a mutable reference to the target if initialized otherwise return an error.

This method is extremly efficient as it does not requires any form of locking when initializing

Trait Implementations

impl<T: Debug, G> Debug for LockedLazy<T, G>

where G: Generator<T>,

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

Formats the value using the given formatter.

impl<T: Default> Default for LockedLazy<T, fn() -> T>

fn default() -> Self

Returns the “default value” for a type.

impl<T, G> Drop for LockedLazy<T, G>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, G> Phased for LockedLazy<T, G>

where G: Generator<T>,

fn phase(this: &Self) -> Phase

return the current phase