Skip to main content

LazySubsystem

Struct LazySubsystem 

Source
pub struct LazySubsystem<T: Send + Sync + 'static> { /* private fields */ }
Expand description

A lazily-initialized subsystem value.

The inner T is initialized on the first call to LazySubsystem::get or LazySubsystem::get_or_try_init. Subsequent calls return the cached value without re-running the initializer.

This is a thin, ergonomic wrapper around tokio::sync::OnceCell that adds logging and a human-readable subsystem name.

Implementations§

Source§

impl<T: Send + Sync + 'static> LazySubsystem<T>

Source

pub fn new(name: &'static str) -> Self

Create a new lazy subsystem with the given human-readable name.

Source

pub async fn get<F, Fut>(&self, init: F) -> &T
where F: FnOnce() -> Fut, Fut: Future<Output = T>,

Get the value, initializing it with init if necessary.

The init future runs at most once, even under concurrent access.

Source

pub async fn get_or_try_init<F, Fut, E>(&self, init: F) -> Result<&T, E>
where F: FnOnce() -> Fut, Fut: Future<Output = Result<T, E>>,

Get the value, initializing with a fallible init if necessary.

If init returns an error, the cell remains uninitialized and future calls will retry.

Source

pub fn is_initialized(&self) -> bool

Check whether the subsystem has been initialized.

Source

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

Return the value if already initialized, without triggering init.

Source

pub fn name(&self) -> &'static str

The human-readable name of this subsystem.

Trait Implementations§

Source§

impl<T: Send + Sync + 'static> Clone for LazySubsystem<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Send + Sync + Debug + 'static> Debug for LazySubsystem<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for LazySubsystem<T>

§

impl<T> !RefUnwindSafe for LazySubsystem<T>

§

impl<T> Send for LazySubsystem<T>

§

impl<T> Sync for LazySubsystem<T>

§

impl<T> Unpin for LazySubsystem<T>

§

impl<T> UnsafeUnpin for LazySubsystem<T>

§

impl<T> !UnwindSafe for LazySubsystem<T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more