Struct KMutex 

pub struct KMutex<Class: LockClass, M: RawLock = RawMutex> { /* private fields */ }

A safe, Zircon-compatible mutual exclusion lock supporting compile-time order validation.

KMutex wraps a platform-specific RawLock abstraction. It is pinned in memory to support FFI loop-detector active list registrations safely under the lock class Class.

Implementations

impl<Class: LockClass, M: RawLock> KMutex<Class, M>

pub fn project<'__pin>( self: Pin<&'__pin mut Self>, ) -> KMutexProjection<'__pin, Class, M>

Pin-projects all fields of Self.

These fields are structurally pinned:

• mutex

These fields are not structurally pinned:

• _marker

impl<Class: LockClass, M: RawLock> KMutex<Class, M>

pub const fn new(mutex: M) -> Self

Create a new KMutex with a pre-initialized raw lock.

pub fn init() -> impl PinInit<Self, Infallible>

Safe dynamic initialization of the validation lock inside pin context.

pub fn lock(&self) -> impl PinInit<KMutexGuard<'_, Class, M>, Infallible>

where <M as RawLock>::DefaultPolicy: LockPolicy<M, AcquireArgs = ()>,

Acquires the lock, using the default policy, and registers the active loop node.

pub fn lock_with( &self, args: <<M as RawLock>::DefaultPolicy as LockPolicy<M>>::AcquireArgs, ) -> impl PinInit<KMutexGuard<'_, Class, M>, Infallible>

Acquires the lock with arguments, using the default policy, and registers the active loop node.

pub fn lock_policy<P: LockPolicy<M, AcquireArgs = ()>>( &self, ) -> impl PinInit<KMutexGuard<'_, Class, M, P>, Infallible>

Acquires the lock, using the specified policy, and registers the active loop node.

pub fn lock_policy_with<P: LockPolicy<M>>( &self, args: P::AcquireArgs, ) -> impl PinInit<KMutexGuard<'_, Class, M, P>, Infallible>

Acquires the lock with arguments, using the specified policy, and registers the active loop node.

pub fn aliased_lock<'a, AliasClass: LockClass, M2: RawLock>( &'a self, alias: &'a KMutex<AliasClass, M2>, ) -> impl PinInit<KMutexAliasedGuard<'a, Class, AliasClass, M, M2>, Infallible>

where <M as RawLock>::DefaultPolicy: LockPolicy<M, AcquireArgs = ()>,

Acquires this lock and aliases it with alias, returning a guard that proves ownership of both Class and AliasClass.

pub fn aliased_lock_with<'a, AliasClass: LockClass, M2: RawLock>( &'a self, alias: &'a KMutex<AliasClass, M2>, args: <<M as RawLock>::DefaultPolicy as LockPolicy<M>>::AcquireArgs, ) -> impl PinInit<KMutexAliasedGuard<'a, Class, AliasClass, M, M2>, Infallible>

Acquires this lock with arguments and aliases it with alias, returning a guard that proves ownership of both Class and AliasClass.

pub fn aliased_lock_policy<'a, AliasClass: LockClass, M2: RawLock, P: LockPolicy<M, AcquireArgs = ()>>( &'a self, alias: &'a KMutex<AliasClass, M2>, ) -> impl PinInit<KMutexAliasedGuard<'a, Class, AliasClass, M, M2, P>, Infallible>

Acquires this lock with policy P and aliases it with alias.

pub fn aliased_lock_policy_with<'a, AliasClass: LockClass, M2: RawLock, P: LockPolicy<M>>( &'a self, alias: &'a KMutex<AliasClass, M2>, args: P::AcquireArgs, ) -> impl PinInit<KMutexAliasedGuard<'a, Class, AliasClass, M, M2, P>, Infallible>

Acquires this lock with policy P and arguments and aliases it with alias.

pub fn raw_mutex(&self) -> &M

Returns a reference to the underlying raw lock.

Trait Implementations

impl<Class: LockClass, M: RawLock> Debug for KMutex<Class, M>

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

Formats the value using the given formatter.

impl<Class: LockClass, M: RawLock> HasPinData for KMutex<Class, M>

type PinData = __ThePinData<Class, M>

unsafe fn __pin_data() -> Self::PinData