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 new() -> Self

Create a new, empty instance.

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

Get an unsafe, mutable reference to the contained Option.

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

Get a safe mutable reference to the contained Option when holding the lock instance exclusively.

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_take(&self) -> T

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

pub fn status(&self) -> Status

Fetch the current status of the lock.

pub fn try_lock(&self) -> Result<OptionGuard<T>, TryLockError>

Try to acquire an exclusive lock.

pub fn try_read(&self) -> Result<OptionRead<T>, ReadError>

Try to acquire a read-only lock.

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

Try to take a stored value from the lock.

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> Default for OptionLock<T>

fn default() -> Self

Returns the "default value" for a type.

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

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

Performs the conversion.

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

fn from(data: T) -> Self

Performs the conversion.

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

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