Struct async_once_cell::Lazy

source · [−]

pub struct Lazy<T, F> { /* private fields */ }

Expand description

A value which is computed on demand by running a future.

Unlike OnceCell, if a task is cancelled, the initializing future’s execution will be continued by other (concurrent or future) callers of Lazy::get.

use std::sync::Arc;
use async_once_cell::Lazy;

struct Data {
    id: u32,
}

let shared = Arc::pin(Lazy::new(async move {
    Data { id: 4 }
}));

assert_eq!(shared.as_ref().get().await.id, 4);

Implementations

source

impl<T, F> Lazy<T, F> where
F: Future<Output = T>,

source

pub fn new(future: F) -> Self

Creates a new lazy value with the given initializing future.

source

pub async fn get(self: Pin<&Self>) -> Pin<&T>

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

The Pin::static_ref function may be useful if this is a static value.

source

impl<T, F> Lazy<T, F>

source

pub const fn from_future(future: F) -> Self

Creates a new lazy value with the given initializing future.

This is equivalent to Self::new but with no type bound.

source

pub const fn with_value(value: T) -> Self

Creates an already-initialized lazy value.

source

pub fn try_get(&self) -> Option<&T>

Gets the value without blocking or starting the initialization.

source

pub fn try_get_mut(self: Pin<&mut Self>) -> Option<Pin<&mut T>>

Gets the value without blocking or starting the initialization.

This requires mutable access to self, so rust’s aliasing rules prevent any concurrent access and allow violating the usual rules for accessing this cell.

source

pub fn try_get_mut_unpin(&mut self) -> Option<&mut T>

Gets the value without blocking or starting the initialization.

This requires mutable access to self, so rust’s aliasing rules prevent any concurrent access and allow violating the usual rules for accessing this cell.

source