Struct TryLock

pub struct TryLock<T> { /* private fields */ }

A light-weight lock guarded by an atomic boolean.

Most efficient when contention is low, acquiring the lock is a single atomic swap, and releasing it just 1 more atomic swap.

It is only possible to try to acquire the lock, it is not possible to wait for the lock to become ready, like with a Mutex.

Implementations

impl<T> TryLock<T>

pub const fn new(val: T) -> TryLock<T>

Create a TryLock around the value.

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

Try to acquire the lock of this value.

If the lock is already acquired by someone else, this returns None. You can try to acquire again whenever you want, perhaps by spinning a few times, or by using some other means of notification.

Note

The default memory ordering is to use Acquire to lock, and Release to unlock. If different ordering is required, use try_lock_explicit or try_lock_explicit_unchecked.

pub fn try_lock_order( &self, lock_order: Ordering, unlock_order: Ordering, ) -> Option<Locked<'_, T>>

👎Deprecated since 0.2.3: This method is actually unsafe because it unsafely allows the use of weaker memory ordering. Please use try_lock_explicit instead

Try to acquire the lock of this value using the lock and unlock orderings.

If the lock is already acquired by someone else, this returns None. You can try to acquire again whenever you want, perhaps by spinning a few times, or by using some other means of notification.

pub fn try_lock_explicit( &self, lock_order: Ordering, unlock_order: Ordering, ) -> Option<Locked<'_, T>>

Try to acquire the lock of this value using the specified lock and unlock orderings.

If the lock is already acquired by someone else, this returns None. You can try to acquire again whenever you want, perhaps by spinning a few times, or by using some other means of notification.

Panic

This method panics if lock_order is not any of Acquire, AcqRel, and SeqCst, or unlock_order is not any of Release and SeqCst.

pub unsafe fn try_lock_explicit_unchecked( &self, lock_order: Ordering, unlock_order: Ordering, ) -> Option<Locked<'_, T>>

Try to acquire the lock of this value using the specified lock and unlock orderings without checking that the specified orderings are strong enough to be safe.

If the lock is already acquired by someone else, this returns None. You can try to acquire again whenever you want, perhaps by spinning a few times, or by using some other means of notification.

Safety

Unlike try_lock_explicit, this method is unsafe because it does not check that the given memory orderings are strong enough to prevent data race.

pub fn into_inner(self) -> T

Take the value back out of the lock when this is the sole owner.

Trait Implementations

impl<T: Debug> Debug for TryLock<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for TryLock<T>

fn default() -> TryLock<T>

Returns the “default value” for a type.

impl<T: Send> Send for TryLock<T>

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

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.