Struct LazyLock 

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

A value which is initialized on the first access.

This type is a thread-safe LazyCell, and can be used in statics. Since initialization may be called from multiple threads, any dereferencing call will block the calling thread if another initialization routine is currently running.

Poisoning

If the initialization closure passed to LazyLock::new panics, the lock will be poisoned. Once the lock is poisoned, any threads that attempt to access this lock (via a dereference or via an explicit call to force()) will panic.

This concept is similar to that of poisoning in the std::sync::poison module. A key difference, however, is that poisoning in LazyLock is unrecoverable. All future accesses of the lock from other threads will panic, whereas a type in std::sync::poison like std::sync::poison::Mutex allows recovery via PoisonError::into_inner().

Examples

Initialize static variables with LazyLock.

use std::sync::LazyLock;

// Note: static items do not call [`Drop`] on program termination, so this won't be deallocated.
// this is fine, as the OS can deallocate the terminated program faster than we can free memory
// but tools like valgrind might report "memory leaks" as it isn't obvious this is intentional.
static DEEP_THOUGHT: LazyLock<String> = LazyLock::new(|| {
    // M3 Ultra takes about 16 million years in --release config
    another_crate::great_question()
});

// The `String` is built, stored in the `LazyLock`, and returned as `&String`.
let _ = &*DEEP_THOUGHT;

Initialize fields with LazyLock.

use std::sync::LazyLock;

#[derive(Debug)]
struct UseCellLock {
    number: LazyLock<u32>,
}
fn main() {
    let lock: LazyLock<u32> = LazyLock::new(|| 0u32);

    let data = UseCellLock { number: lock };
    println!("{}", *data.number);
}

Implementations

impl<T, F> LazyLock<T, F>

where F: FnOnce() -> T,

pub const fn new(f: F) -> LazyLock<T, F>

Creates a new lazy value with the given initializing function.

Examples

use std::sync::LazyLock;

let hello = "Hello, World!".to_string();

let lazy = LazyLock::new(|| hello.to_uppercase());

assert_eq!(&*lazy, "HELLO, WORLD!");

pub fn into_inner(this: LazyLock<T, F>) -> Result<T, F>

🔬This is a nightly-only experimental API. (lazy_cell_into_inner)

Consumes this LazyLock returning the stored value.

Returns Ok(value) if Lazy is initialized and Err(f) otherwise.

Panics

Panics if the lock is poisoned.

Examples

#![feature(lazy_cell_into_inner)]

use std::sync::LazyLock;

let hello = "Hello, World!".to_string();

let lazy = LazyLock::new(|| hello.to_uppercase());

assert_eq!(&*lazy, "HELLO, WORLD!");
assert_eq!(LazyLock::into_inner(lazy).ok(), Some("HELLO, WORLD!".to_string()));

pub fn force_mut(this: &mut LazyLock<T, F>) -> &mut T

Forces the evaluation of this lazy value and returns a mutable reference to the result.

Panics

If the initialization closure panics (the one that is passed to the new() method), the panic is propagated to the caller, and the lock becomes poisoned. This will cause all future accesses of the lock (via force() or a dereference) to panic.

Examples

use std::sync::LazyLock;

let mut lazy = LazyLock::new(|| 92);

let p = LazyLock::force_mut(&mut lazy);
assert_eq!(*p, 92);
*p = 44;
assert_eq!(*lazy, 44);

pub fn force(this: &LazyLock<T, F>) -> &T

Forces the evaluation of this lazy value and returns a reference to result. This is equivalent to the Deref impl, but is explicit.

This method will block the calling thread if another initialization routine is currently running.

Panics

If the initialization closure panics (the one that is passed to the new() method), the panic is propagated to the caller, and the lock becomes poisoned. This will cause all future accesses of the lock (via force() or a dereference) to panic.

Examples

use std::sync::LazyLock;

let lazy = LazyLock::new(|| 92);

assert_eq!(LazyLock::force(&lazy), &92);
assert_eq!(&*lazy, &92);

impl<T, F> LazyLock<T, F>

pub fn get_mut(this: &mut LazyLock<T, F>) -> Option<&mut T>

Returns a mutable reference to the value if initialized. Otherwise (if uninitialized or poisoned), returns None.

Examples

use std::sync::LazyLock;

let mut lazy = LazyLock::new(|| 92);

assert_eq!(LazyLock::get_mut(&mut lazy), None);
let _ = LazyLock::force(&lazy);
*LazyLock::get_mut(&mut lazy).unwrap() = 44;
assert_eq!(*lazy, 44);

pub fn get(this: &LazyLock<T, F>) -> Option<&T>

Returns a reference to the value if initialized. Otherwise (if uninitialized or poisoned), returns None.

Examples

use std::sync::LazyLock;

let lazy = LazyLock::new(|| 92);

assert_eq!(LazyLock::get(&lazy), None);
let _ = LazyLock::force(&lazy);
assert_eq!(LazyLock::get(&lazy), Some(&92));

pub unsafe fn get_unchecked(this: &LazyLock<T, F>) -> &T

🔬This is a nightly-only experimental API. (once_lazy_lock_get_unchecked)

Returns a shared reference to the value stored in the LazyLock without checking whether it has been initialized.

Safety

The lazy value must be initialized before calling this function.

Examples

#![feature(once_lazy_lock_get_unchecked)]

use std::sync::LazyLock;

let lazy = LazyLock::new(|| 42);

// Initialize the lazy.
let _ = &*lazy;

let value = unsafe { LazyLock::get_unchecked(&lazy) };
assert_eq!(*value, 42);

pub unsafe fn get_unchecked_mut(this: &mut LazyLock<T, F>) -> &mut T

🔬This is a nightly-only experimental API. (once_lazy_lock_get_unchecked)

Returns a mutable reference to the value stored in the LazyLock without checking whether it has been initialized.

Safety

The lazy value must be initialized before calling this function.

Examples

#![feature(once_lazy_lock_get_unchecked)]

use std::sync::LazyLock;

let mut lazy = LazyLock::new(|| 42);

// Initialize the lazy.
let _ = &*lazy;

let value = unsafe { LazyLock::get_unchecked_mut(&mut lazy) };
*value = 100;

assert_eq!(*lazy, 100);

Trait Implementations

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

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for LazyLock<T>

where T: Default,

fn default() -> LazyLock<T>

Creates a new lazy value using Default as the initializing function.

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

where F: FnOnce() -> T,

fn deref(&self) -> &T

Dereferences the value.

This method will block the calling thread if another initialization routine is currently running.

Panics

If the initialization closure panics (the one that is passed to the new() method), the panic is propagated to the caller, and the lock becomes poisoned. This will cause all future accesses of the lock (via force() or a dereference) to panic.

type Target = T

The resulting type after dereferencing.

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

where F: FnOnce() -> T,

fn deref_mut(&mut self) -> &mut T

Panics

If the initialization closure panics (the one that is passed to the new() method), the panic is propagated to the caller, and the lock becomes poisoned. This will cause all future accesses of the lock (via force() or a dereference) to panic.

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

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T, F> From<T> for LazyLock<T, F>

fn from(value: T) -> LazyLock<T, F>

Constructs a LazyLock that starts already initialized with the provided value.

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

where T: RefUnwindSafe + UnwindSafe, F: UnwindSafe,

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

where T: Sync + Send, F: Send,

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

where T: UnwindSafe, F: UnwindSafe,