Trait hala_sync::Lockable

pub trait Lockable {
    type GuardMut<'a>
       where Self: 'a;

    // Required methods
    fn lock(&self) -> Self::GuardMut<'_>;
    fn try_lock(&self) -> Option<Self::GuardMut<'_>>;
    fn unlock(guard: Self::GuardMut<'_>) -> &Self;
}

Any mutex object should implement this trait

Required Associated Types

type GuardMut<'a> where Self: 'a

RAII scoped lock guard type.

Required Methods

fn lock(&self) -> Self::GuardMut<'_>

Lock self and returns RAII locker guard object.

fn try_lock(&self) -> Option<Self::GuardMut<'_>>

Attempts to acquire this lock.

If the lock could not be acquired at this time, then None is returned. Otherwise, an RAII guard is returned. The lock will be unlocked when the guard is dropped.

fn unlock(guard: Self::GuardMut<'_>) -> &Self

Immediately drops the guard, and consequently unlocks the Lockable object.

The return value is the associated Lockable object of this guard

Object Safety

This trait is not object safe.

Implementors

impl<T> Lockable for SpinMutex<T>

type GuardMut<'a> = SpinMutexGuard<'a, T> where Self: 'a