Struct std::sync::LazyLock

source ·
pub struct LazyLock<T, F = fn() -> T> {
    once: Once,
    data: UnsafeCell<Data<T, F>>,
}
🔬This is a nightly-only experimental API. (lazy_cell #109736)
Expand description

A value which is initialized on the first access.

This type is a thread-safe LazyCell, and can be used in statics.

Examples

#![feature(lazy_cell)]

use std::collections::HashMap;

use std::sync::LazyLock;

static HASHMAP: LazyLock<HashMap<i32, String>> = LazyLock::new(|| {
    println!("initializing");
    let mut m = HashMap::new();
    m.insert(13, "Spica".to_string());
    m.insert(74, "Hoyten".to_string());
    m
});

fn main() {
    println!("ready");
    std::thread::spawn(|| {
        println!("{:?}", HASHMAP.get(&13));
    }).join().unwrap();
    println!("{:?}", HASHMAP.get(&74));

    // Prints:
    //   ready
    //   initializing
    //   Some("Spica")
    //   Some("Hoyten")
}
Run

Fields§

§once: Once
🔬This is a nightly-only experimental API. (lazy_cell #109736)
§data: UnsafeCell<Data<T, F>>
🔬This is a nightly-only experimental API. (lazy_cell #109736)

Implementations§

source§

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

source

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

🔬This is a nightly-only experimental API. (lazy_cell #109736)

Creates a new lazy value with the given initializing function.

source

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

🔬This is a nightly-only experimental API. (lazy_cell_consume #109736)

Consumes this LazyLock returning the stored value.

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

Examples
#![feature(lazy_cell)]
#![feature(lazy_cell_consume)]

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()));
Run
source

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

🔬This is a nightly-only experimental API. (lazy_cell #109736)

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

Examples
#![feature(lazy_cell)]

use std::sync::LazyLock;

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

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

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

source

fn get(&self) -> Option<&T>

Get the inner value if it has already been initialized.

Trait Implementations§

source§

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

source§

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

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

impl<T: Default> Default for LazyLock<T>

source§

fn default() -> LazyLock<T>

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

source§

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

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<T: RefUnwindSafe + UnwindSafe, F: UnwindSafe> RefUnwindSafe for LazyLock<T, F>

source§

impl<T: Sync + Send, F: Send> Sync for LazyLock<T, F>

source§

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

Auto Trait Implementations§

§

impl<T, F> Send for LazyLock<T, F>where F: Send, T: Send,

§

impl<T, F> Unpin for LazyLock<T, F>where F: Unpin, T: Unpin,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.