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 instance with no stored value.

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

Create a new populated instance.

pub fn is_none_unlocked(&self) -> bool

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

pub fn is_some_unlocked(&self) -> bool

Check if there is a 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_get(&self) -> MutexGuard<'_, T>

In a spin loop, wait to get an exclusive lock on the contained value.

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 an empty slot.

pub fn spin_take(&self) -> T

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

pub fn try_get(&self) -> Result<MutexGuard<'_, T>, OptionLockError>

Try to acquire an exclusive lock around a contained value.

On successful acquisition a MutexGuard<'_, T> is returned, representing an exclusive read/write lock.

pub fn try_get_arc(
    self: &Arc<Self>
) -> Result<MutexGuardArc<T>, OptionLockError>

Try to acquire an exclusive lock around the value in an Arc<OptionLock>.

On successful acquisition a MutexGuardArc<T> is returned, representing an exclusive read/write lock.

pub fn try_fill(&self, value: T) -> Result<(), T>

Try to store a value, if the slot is currently empty and a lock can be acquired.

pub fn try_fill_with(
    &self,
    f: impl FnOnce() -> T
) -> Result<(), OptionLockError>

Store the result of an initializer function if the slot is currently empty and a lock can be acquired. If a lock cannot be acquired, then the initializer is never called.

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

Try to acquire an exclusive lock.

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

pub fn try_lock_arc(
    self: &Arc<Self>
) -> Result<OptionGuardArc<T>, OptionLockError>

Try to acquire an exclusive lock from a reference to an Arc<OptionLock>.

On successful acquisition an OptionGuardArc<T> is returned, representing an exclusive read/write lock.

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

Try to acquire an exclusive lock when there is no value currently stored.

pub fn try_lock_empty_arc(
    self: &Arc<Self>
) -> Result<OptionGuardArc<T>, OptionLockError>

Try to acquire an exclusive lock when there is no value currently stored.

pub fn try_take(&self) -> Result<T, OptionLockError>

Try to take a stored value from the lock.

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.

impl<T: Clone> OptionLock<T>

pub fn try_clone(&self) -> Result<T, OptionLockError>

Try to clone the contained resource.

impl<T: Copy> OptionLock<T>

pub fn try_copy(&self) -> Result<T, OptionLockError>

Try to copy the contained resource.

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>