Struct maitake::sync::mutex::Lock

pub struct Lock<'a, T, L = DefaultMutex>
where
    L: ScopedRawMutex,
    T: ?Sized,
{ /* private fields */ }

A future returned by the Mutex::lock method.

Notes

This future is !Unpin, as it is unsafe to core::mem::forget a Lock future once it has been polled. For instance, the following code must not compile:

 use maitake_sync::mutex::Lock;

 // Calls to this function should only compile if `T` is `Unpin`.
 fn assert_unpin<T: Unpin>() {}

 assert_unpin::<Lock<'_, ()>>();

Trait Implementations

impl<'a, T, L> Debug for Lock<'a, T, L>

where T: Debug + ?Sized, L: Debug + ScopedRawMutex,

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

Formats the value using the given formatter.

impl<'a, T> Future for Lock<'a, T>

type Output = MutexGuard<'a, T>

The type of value produced on completion.

fn poll( self: Pin<&mut Lock<'a, T>>, cx: &mut Context<'_>, ) -> Poll<<Lock<'a, T> as Future>::Output>

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

impl<'pin, 'a, T, L> Unpin for Lock<'a, T, L>

where L: ScopedRawMutex, __Lock<'pin, 'a, T, L>: Unpin, T: ?Sized,