Struct Singleton

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

A pointer type for holding shared global state in multi-thread environment.

Implementations§

Source§

impl<T: Send + Sync> Singleton<T>

Source

pub fn new() -> Self

Create an uninitialized singleton.

Source

pub fn get(&self) -> &T
where T: Default,

Access the singleton; initialize it with Default::default() if it is uninitialized.

Source

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

Access the singleton; or return None if it is not yet uninitialized.

Source

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

Access the singleton; initialize it with custom function if it is uninitialized.

Source

pub unsafe fn finalize(&self)

Put the singleton into a finalized state, destruct the singleton value if it is initialized.

This is unsafe and only useful when the value holds other resources.

Trait Implementations§

Source§

impl<T: Send + Sync> Default for Singleton<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T: Send + Sync> Drop for Singleton<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for Singleton<T>

§

impl<T> RefUnwindSafe for Singleton<T>

§

impl<T> Send for Singleton<T>

§

impl<T> Sync for Singleton<T>

§

impl<T> Unpin for Singleton<T>

§

impl<T> UnwindSafe for Singleton<T>
where T: RefUnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.