Struct SingletonUninit 

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

A thread-unsafe global singleton which is initially uninitialized memory.

Using this across threads is undefined behaviour.

Panics

In debug builds, usage of this abstraction is checked for safety at runtime.

• Using this struct across threads will panic.
• Mixing mutabilty of borrows will panic (this is bypassed if you are using the pointer getters)
• Using this struct before initializing it will panic.
• Initializing the value more than once will panic. Use replace

Implementations

impl<T> SingletonUninit<T>

pub const fn uninit() -> Self

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

pub fn get(&'static self) -> SinglytonRef<T>

Assumes the memory is initialized and acquires an immutable reference to the singleton.

In debug builds, this will panic if the memory is not initialized, the singleton is mutably accessed from a different thread, or a mutable reference is currently held.

pub fn get_mut(&'static self) -> SinglytonRefMut<T>

Acquires a mutable reference to the singleton.

In debug builds, this will panic if the memory is not initialized, the singleton is mutably accessed from a different thread, or an existing mutable or immutable reference is currently held.

pub unsafe fn as_ptr(&'static self) -> *const T

Acquires an immutable pointer to the singleton.

In debug builds, this will panic if the memory is not initialized, the singleton is mutably accessed from a different thread, or a mutable reference is currently held.

This is unsafe because the returned pointer bypasses any future borrow checking.

pub unsafe fn as_mut_ptr(&'static self) -> *mut T

Acquires a mutable pointer to the singleton.

In debug builds, this will panic if the memory is not initialized, the singleton is mutably accessed from a different thread, or an existing mutable or immutable reference is currently held.

This is unsafe because the returned pointer bypasses any future borrow checking.

pub fn replace(&'static self, val: T)

Replaces the value in the singleton with anew.

In debug builds, this will panic if the memory is not initialized, the singleton is mutably accessed from a different thread, or an existing mutable or immutable reference is currently held.

pub fn init(&'static self, val: T)

Initializes the memory in the singleton.

In debug builds, this will panic if the memory is already initialized, the singleton is mutably accessed from a different thread, or an existing mutable or immutable reference is currently held.

Trait Implementations

impl<T> Sync for SingletonUninit<T>