Struct LockWaiter 

pub struct LockWaiter<K>
where
    K: Hash + Eq + Clone + Send + Sync + 'static,
{ /* private fields */ }

A LockWaiter represents a waiter waiting to access a lock on a key.

The LockWaiter can be consumed synchronously using LockWaiter::wait (which will park the current thread until it is available) or asynchronously through .await.

Example:

let waiter = store.lock("test");
let guard = waiter.wait();
// OR
let guard = waiter.await;

Implementations

impl<K> LockWaiter<K>

where K: Hash + Eq + Clone + Send + Sync + 'static,

pub fn wait(self) -> LockGuard<K>

where K: Hash + Eq + Clone + Send + Sync + 'static,

Wait for the lock to be available and acquire a guard, when the guard is dropped the lock is released and can be acquired again Note: Calling this method will park the current thread, this may cause issues, especially in an asynchronous context, and cause a deadlock.

Example

let waiter = store.lock("test");
let guard = waiter.wait();

Trait Implementations

impl<K> Clone for LockWaiter<K>

where K: Hash + Eq + Clone + Send + Sync + 'static + Clone,

fn clone(&self) -> LockWaiter<K>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K> Debug for LockWaiter<K>

where K: Hash + Eq + Clone + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.

impl<K> Future for LockWaiter<K>

where K: Hash + Eq + Clone + Send + Sync + 'static,

type Output = LockGuard<K>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.