Struct OncePtr

pub struct OncePtr<T>(/* private fields */);

An atomic pointer that can only be initialized once.

Implementations

impl<T> OncePtr<T>

pub fn null() -> Self

Create a new uninitialized pointer.

pub fn new(value: T) -> Self

Create a new initialized pointer for the given data.

pub fn store(&self, value: T)

Initialize the store with the provided value.

Panics

If the store is already initialized before.

pub fn is_null(&self) -> bool

Returns true if the store is not initialized and is null.

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

Load the atomic store and return a reference to the underlying data or None if the store is not initialized yet.

pub unsafe fn load_unchecked(&self) -> &T

Load the atomic store and return a reference to the underlying data without checking if it’s null.

Safety

It is up to the caller to ensure that the pointer is not null.

pub fn load_mut(&mut self) -> Option<&mut T>

Load the atomic store and return a mutable reference to the underlying data or None if the store is not initialized yet.

This is safe because the mutable reference guarantees that no other threads are concurrently accessing the atomic data.

pub unsafe fn load_mut_unchecked(&mut self) -> &mut T

Load the atomic store and return a mutable reference to the underlying data without checking if it’s null.

Safety

It is up to the caller to ensure that the pointer is not null.

pub fn into_inner(self) -> Option<T>

Returns the data owned by this store.

Trait Implementations

impl<T> Default for OncePtr<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for OncePtr<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<T> for OncePtr<T>

fn from(value: T) -> Self

Converts to this type from the input type.