Struct InitCell 

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

A one-time initialization cell.

This is mostly intended for use in statics. The cell is safe to access, but must be initialized before any access. There is no synchronization to ensure initialization is observed, so you should initialize at the beginning of the main function or using something like the ctor crate.

Implementations

impl<T> InitCell<T>

pub const unsafe fn new() -> Self

Creates a new uninitialized InitCell.

Safety

The cell must be initialized before it is accessed.

pub fn initialized(x: T) -> Self

Creates a new initialized InitCell. Unlike InitCell::new, this is safe because the cell is already initialized and can be used freely.

pub unsafe fn into_inner(cell: Self) -> T

Gets the inner (initialized) value of this cell.

pub unsafe fn init(cell: &Self, x: T)

Initializes the cell.

Safety

This must be done when there are no references to the contents of this cell, including no other threads accessing it.

pub unsafe fn set(cell: &Self, x: T)

Sets the cell’s value.

Safety

This must be done when there are no references to the contents of this cell, including no other threads accessing it. Additionally, the cell must have been previously initialized, as this will drop the old value.

Trait Implementations

impl<T: Debug> Debug for InitCell<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Deref for InitCell<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for InitCell<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Display> Display for InitCell<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> From<T> for InitCell<T>

fn from(x: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for InitCell<T>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for InitCell<T>

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for InitCell<T>

fn eq(&self, rhs: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for InitCell<T>

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for InitCell<T>

impl<T: Send> Send for InitCell<T>

impl<T: Sync> Sync for InitCell<T>