Struct option_lock::OptionLock

pub struct OptionLock<T> { /* fields omitted */ }

A read/write lock around an Option value.

Implementations

impl<T> OptionLock<T>

pub const fn empty() -> Self

Create a new, empty instance.

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

Create a new populated instance.

pub fn is_some_unlocked(&self) -> bool

Check if there is a stored value and no guard held.

pub fn is_none_unlocked(&self) -> bool

Check if there is no stored value and no guard held.

pub fn is_locked(&self) -> bool

Check if a guard is held.

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

Get a mutable reference to the contained value, if any.

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

Unwrap an owned lock instance.

pub fn spin_lock(&self) -> OptionGuard<'_, T>

In a spin loop, wait to acquire the lock.

pub fn spin_lock_none(&self) -> OptionGuard<'_, T>

In a spin loop, wait to acquire the lock with a value of None.

pub fn spin_take(&self) -> T

In a spin loop, wait to take a value from the lock.

pub fn try_lock(&self) -> Option<OptionGuard<'_, T>>

Try to acquire an exclusive lock.

On successful acquisition Some(OptionGuard<'_, T>) is returned, representing an exclusive read/write lock.

pub fn try_lock_none(&self) -> Option<OptionGuard<'_, T>>

Try to acquire an exclusive lock, but only if the value is currently None.

On successful acquisition Some(OptionGuard<'_, T>) is returned, representing an exclusive read/write lock.

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

Try to take a stored value from the lock.

On successful acquisition Some(T) is returned.

On failure, None is returned. Acquisition can fail either because there is no contained value, or because the lock is held by a guard.

pub fn replace(&mut self, value: T) -> Option<T>

Replace the value in an owned OptionLock.

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

Take the value (if any) from an owned OptionLock.

Trait Implementations

impl<T> Debug for OptionLock<T>

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

Formats the value using the given formatter.

impl<T> Default for OptionLock<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Drop for OptionLock<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<Option<T>> for OptionLock<T>

fn from(data: Option<T>) -> Self

Performs the conversion.

impl<T> From<OptionLock<T>> for OnceCell<T>

fn from(lock: OptionLock<T>) -> Self

Performs the conversion.

impl<T> From<T> for OptionLock<T>

fn from(data: T) -> Self

Performs the conversion.

impl<T> Into<Option<T>> for OptionLock<T>

fn into(self) -> Option<T>

Performs the conversion.

impl<T: Send> Send for OptionLock<T>

impl<T: Send> Sync for OptionLock<T>