std::sync

Struct LazyLock

1.80.0 · source

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

Expand description

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.

§Examples

Initialize static variables with LazyLock.

use std::sync::LazyLock;

// n.b. 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§

source §

impl<T, F: FnOnce() -> T> LazyLock<T, F>

1.80.0 (const: 1.80.0) · source

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!");

source

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

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

Consumes this LazyLock returning the stored value.

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

§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()));

source

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

🔬This is a nightly-only experimental API. (lazy_get #129333)

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

§Examples

#![feature(lazy_get)]
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);

1.80.0 · source

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.

§Examples

use std::sync::LazyLock;

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

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

source §

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

source

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

🔬This is a nightly-only experimental API. (lazy_get #129333)

Returns a reference to the value if initialized, or None if not.

§Examples

#![feature(lazy_get)]

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);

source

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

🔬This is a nightly-only experimental API. (lazy_get #129333)

Returns a mutable reference to the value if initialized, or None if not.

§Examples

#![feature(lazy_get)]

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));