Trait hala_sync::AsyncLockable

pub trait AsyncLockable {
    type GuardMut<'a>: AsyncGuardMut<'a, Locker = Self> + Send + Unpin
       where Self: 'a;
    type GuardMutFuture<'a>: Future<Output = Self::GuardMut<'a>> + Send
       where Self: 'a;

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

A futures-aware lockable mutex object should implement this trait.

Required Associated Types

type GuardMut<'a>: AsyncGuardMut<'a, Locker = Self> + Send + Unpin where Self: 'a

RAII scoped lock guard type.

A guard of futures-aware mutex must be able to transfer between threads In other words, this guard must not track any thread-specific details

type GuardMutFuture<'a>: Future<Output = Self::GuardMut<'a>> + Send where Self: 'a

Future created by lock function

Required Methods

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

Acquire the lock asynchronously.

fn unlock<'a>(guard: Self::GuardMut<'a>) -> &'a 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<Locker, Wakers, Mediator> AsyncLockable for AsyncLockableMaker<Locker, Wakers>

where Locker: Lockable + Send + Sync, for<'a> Locker::GuardMut<'a>: Send + Unpin, Wakers: Lockable + Send + Sync, for<'b> Wakers::GuardMut<'b>: DerefMut<Target = Mediator>, Mediator: AsyncLockableMediator + 'static,

type GuardMut<'a> = AsyncLockableMakerGuard<'a, Locker, Wakers, Mediator> where Self: 'a

type GuardMutFuture<'a> = AsyncLockableMakerFuture<'a, Locker, Wakers, Mediator> where Self: 'a