Struct ruspiro_singleton::Singleton

pub struct Singleton<T: 'static> { /* fields omitted */ }

The Singleton wrapper stores any type

Implementations

impl<T: 'static> Singleton<T>

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

Create a new Singleton instance to be used in a static variable. Only const fn constructors are allowed here.

Example

static FOO: Singleton<u32> = Singleton::new(20);

pub const fn lazy<F>(init: &'static F) -> Self where
    F: Fn() -> T, 

Create a new Singleton instance passing a closure that will be evaluated at first access to the contents of the singleton that will provide its value

Example

static FOO: Singleton<String> = Singleton::lazy(&|| String::from("foo"));

pub fn with_mut<F, R>(&self, f: F) -> R where
    F: FnOnce(&mut T) -> R, 

Take the stored singleton for whatever operation and prevent usage by other cores Safe access to the singleton mutable instance is guarantied inside the given closure.

pub fn with_ref<F, R>(&self, f: F) -> R where
    F: FnOnce(&T) -> R, 

Immutable access to a singleton for a specific operation. This access does not enforce any lock nor guarantees safe atomic access to the instance. However, it is usefull in read-only access scenarios like inside interrupt handlers.

Trait Implementations

impl<T> Send for Singleton<T> where
    T: Send, 

impl<T> Sync for Singleton<T> where
    T: Sync,