Skip to main content

KMutexGuardMultiple

Struct KMutexGuardMultiple 

Source
pub struct KMutexGuardMultiple<'a, const N: usize, Class: LockClass, M: RawLock = RawMutex, P: LockPolicy<M> = <M as RawLock>::DefaultPolicy> { /* private fields */ }
Expand description

Guards simultaneous acquisitions of multiple locks of the same class and type.

Locks are automatically sorted in-place by ascending memory address before acquisition to preserve the intra-class ordering invariant and prevent AB/BA deadlocks, matching C++ lockdep::GuardMultiple.

Implementations§

Source§

impl<'a, const N: usize, Class: LockClass, M: RawLock, P: LockPolicy<M>> KMutexGuardMultiple<'a, N, Class, M, P>

Source

pub fn project<'__pin>( self: Pin<&'__pin mut Self>, ) -> KMutexGuardMultipleProjection<'__pin, 'a, N, Class, M, P>

Pin-projects all fields of Self.

These fields are structurally pinned:

  • lock_entries

These fields are not structurally pinned:

  • mutexes
  • states
  • tokens
Source§

impl<'a, const N: usize, Class: LockClass, M: RawLock, P: LockPolicy<M>> KMutexGuardMultiple<'a, N, Class, M, P>

Source

pub fn new(locks: [&'a KMutex<Class, M>; N]) -> impl PinInit<Self, Infallible>
where P: LockPolicy<M, AcquireArgs = ()>,

Creates a new stack-pinned multi-lock validation guard initialization block.

Source

pub fn new_with_args( locks: [&'a KMutex<Class, M>; N], args: P::AcquireArgs, ) -> impl PinInit<Self, Infallible>

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

Source

pub fn tokens(&self) -> &[LockToken<'a, Class>; N]

Returns shared references to the lock proof tokens.

Source

pub fn tokens_mut(self: Pin<&mut Self>) -> &mut [LockToken<'a, Class>; N]

Returns mutable references to the lock proof tokens.

Source

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

Explicitly releases all held locks in reverse order before the guard is dropped.

If the locks have already been released, this is a no-op.

Trait Implementations§

Source§

impl<'a, const N: usize, Class: LockClass, M: RawLock, P: LockPolicy<M>> Drop for KMutexGuardMultiple<'a, N, Class, M, P>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

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. Read more
Source§

impl<'a, const N: usize, Class: LockClass, M: RawLock, P: LockPolicy<M>> HasPinData for KMutexGuardMultiple<'a, N, Class, M, P>

Source§

type PinData = __ThePinData<'a, N, Class, M, P>

Source§

unsafe fn __pin_data() -> Self::PinData

Source§

impl<'a, const N: usize, Class: LockClass, M: RawLock, P: LockPolicy<M>> PinnedDrop for KMutexGuardMultiple<'a, N, Class, M, P>

Source§

fn drop(self: Pin<&mut Self>, _: OnlyCallFromDrop)

Executes the pinned destructor of this type. Read more

Auto Trait Implementations§

§

impl<'a, const N: usize, Class, M = RawMutex, P = <M as RawLock>::DefaultPolicy> !Send for KMutexGuardMultiple<'a, N, Class, M, P>

§

impl<'a, const N: usize, Class, M = RawMutex, P = <M as RawLock>::DefaultPolicy> !Sync for KMutexGuardMultiple<'a, N, Class, M, P>

§

impl<'a, const N: usize, Class, M, P> Freeze for KMutexGuardMultiple<'a, N, Class, M, P>
where <M as RawLock>::LockEntry: Freeze, <P as LockPolicy<M>>::GuardState: Freeze,

§

impl<'a, const N: usize, Class, M, P> RefUnwindSafe for KMutexGuardMultiple<'a, N, Class, M, P>
where <M as RawLock>::LockEntry: RefUnwindSafe, <P as LockPolicy<M>>::GuardState: RefUnwindSafe, M: RefUnwindSafe, Class: RefUnwindSafe,

§

impl<'a, const N: usize, Class, M, P> UnsafeUnpin for KMutexGuardMultiple<'a, N, Class, M, P>
where <M as RawLock>::LockEntry: UnsafeUnpin, <P as LockPolicy<M>>::GuardState: UnsafeUnpin,

§

impl<'a, const N: usize, Class, M, P> UnwindSafe for KMutexGuardMultiple<'a, N, Class, M, P>
where <M as RawLock>::LockEntry: UnwindSafe, <P as LockPolicy<M>>::GuardState: UnwindSafe, M: RefUnwindSafe, Class: RefUnwindSafe,

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Init<T> for T

Source§

unsafe fn __init(self, slot: *mut T) -> Result<(), !>

Initializes slot. Read more
Source§

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

Source§

impl<T> PinInit<T> for T

Source§

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), !>

Initializes slot. Read more
Source§

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T> ToMutPtr for T
where T: ?Sized,

Source§

type Target = T

The target type of the pointer.
Source§

fn to_mut_ptr(&self) -> *mut T

Casts the reference to a mutable raw pointer.
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = !

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.