Struct FreezeLock

pub struct FreezeLock<T> {
    data: UnsafeCell<T>,
    frozen: AtomicBool,
    lock: RwLock<()>,
}

A type which allows mutation using a lock until the value is frozen and can be accessed lock-free.

Unlike RwLock, it can be used to prevent mutation past a point.

Fields

data: UnsafeCell<T>

frozen: AtomicBool

lock: RwLock<()>

This lock protects writes to the data and frozen fields.

Implementations

impl<T> FreezeLock<T>

pub fn new(value: T) -> Self

pub fn frozen(value: T) -> Self

pub fn with(value: T, frozen: bool) -> Self

pub fn clone(&self) -> Self

where T: Clone,

Clones the inner value along with the frozen state.

pub fn is_frozen(&self) -> bool

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

Get the inner value if frozen.

pub fn read(&self) -> FreezeReadGuard<'_, T>

pub fn borrow(&self) -> FreezeReadGuard<'_, T>

pub fn write(&self) -> FreezeWriteGuard<'_, T>

pub fn try_write(&self) -> Option<FreezeWriteGuard<'_, T>>

pub fn freeze(&self) -> &T

Trait Implementations

impl<T: Default> Default for FreezeLock<T>

fn default() -> FreezeLock<T>

Returns the “default value” for a type.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.