Struct KMutexGuard 

pub struct KMutexGuard<'a, Class: LockClass, M: RawLock = RawMutex, P: ExclusiveLockPolicy<M> = <M as RawLock>::DefaultPolicy> { /* private fields */ }

A validation guard representing exclusive lock ownership and active list participation.

The guard is pinned in memory to ensure that its state remains safe and valid inside the C++ loop detector active thread list.

Implementations

impl<'a, Class: LockClass, M: RawLock, P: ExclusiveLockPolicy<M>> KMutexGuard<'a, Class, M, P>

pub fn new(mutex: &'a KMutex<Class, M>) -> impl PinInit<Self, Infallible>

where P: ExclusiveLockPolicy<M, AcquireArgs = ()>,

Creates a new stack-pinned validation guard initialization block.

pub fn new_with_args( mutex: &'a KMutex<Class, M>, args: P::AcquireArgs, ) -> impl PinInit<Self, Infallible>

Creates a new stack-pinned validation guard initialization block with policy acquire arguments.

pub fn token(&self) -> &LockToken<'a, Class>

Returns a shared reference to the lock proof LockToken.

pub fn token_mut(self: Pin<&mut Self>) -> &mut LockToken<'a, Class>

Returns a mutable reference to the lock proof LockToken inside this pinned projection.

pub unsafe fn token_unchecked(&self) -> &LockToken<'a, Class>

Safety

The guard has not been released.

pub unsafe fn token_mut_unchecked( self: Pin<&mut Self>, ) -> &mut LockToken<'a, Class>

Safety

The guard has not been released.

pub fn is_locked_by(&self, target: &KMutex<Class, M>) -> bool

Returns true if this guard currently holds the given target mutex instance.

pub fn release(self: Pin<&mut Self>)

Explicitly releases the lock before the guard is dropped.

If the lock has already been released, this is a no-op.

pub fn call_unlocked<R, F: FnOnce() -> R>(self: Pin<&mut Self>, f: F) -> R

Temporarily releases the lock before executing the given callable f and then re-acquires the lock.

pub fn call_untracked<R, F: FnOnce(&mut LockToken<'a, Class>) -> R>( self: Pin<&mut Self>, f: F, ) -> R

Calls a closure while temporarily disabling lockdep tracking for the lock held by this guard.

Trait Implementations

impl<'a, Class: LockClass, M: RawLock, P: ExclusiveLockPolicy<M>> Drop for KMutexGuard<'a, Class, M, P>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.