Struct agb::sync::InitOnce

pub struct InitOnce<T> { /* private fields */ }

A helper type that ensures a particular value is only initialized once.

Implementations

impl<T> InitOnce<T>

pub const fn new() -> Self

Creates a new uninitialized object.

pub fn get(&self, initializer: impl FnOnce() -> T) -> &T

Gets the contents of this state, or initializes it if it has not already been initialized.

The initializer function is guaranteed to only be called once.

This function disables IRQs while it is initializing the inner value. While this can cause audio skipping and other similar issues, it is not normally a problem as interrupts will only be disabled once per InitOnce during the life cycle of the program.

pub fn try_get<E>( &self, initializer: impl FnOnce() -> Result<T, E> ) -> Result<&T, E>

Gets the contents of this state, or initializes it if it has not already been initialized.

The initializer function is guaranteed to only be called once if it returns Ok. If it returns Err, it will be called again in the future until an attempt at initialization succeeds.

This function disables IRQs while it is initializing the inner value. While this can cause audio skipping and other similar issues, it is not normally a problem as interrupts will only be disabled once per InitOnce during the life cycle of the program.

Trait Implementations

impl<T> Default for InitOnce<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for InitOnce<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Send for InitOnce<T>

impl<T: Sync> Sync for InitOnce<T>