Skip to main content

RawMutexStorage

Struct RawMutexStorage 

Source
pub struct RawMutexStorage { /* private fields */ }
Expand description

Opaque layout block matching the Zircon C++ Mutex (and CriticalMutex) object.

Implementations§

Source§

impl RawMutexStorage

Source

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

Pin-projects all fields of Self.

These fields are structurally pinned:

These fields are not structurally pinned:

  • storage
Source§

impl RawMutexStorage

Source

pub const INIT: Self

Source

pub const fn const_init() -> Self

Statically initializes a RawMutexStorage in constant context.

Source

pub fn is_contested(&self) -> bool

Is the mutex contested i.e. is at least one thread blocked waiting on it?

The contested flag does not track threads which are spin-waiting on the Mutex and have yet to enter a blocking phase.

Source

pub fn raw_storage_slice(&self) -> &[u8]

Returns a slice over the raw mutex storage bytes.

Trait Implementations§

Source§

impl ConstRawLock for RawMutexStorage

Source§

const INIT: Self = Self::INIT

Constant-initialized value for the lock.
Source§

impl Default for RawMutexStorage

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for RawMutexStorage

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 ExclusiveLockPolicy<RawMutexStorage> for RawMutexStorage

Source§

impl ExclusiveLockPolicy<RawMutexStorage> for RawCriticalMutexPolicy

Source§

impl HasPinData for RawMutexStorage

Source§

type PinData = __ThePinData

Source§

unsafe fn __pin_data() -> Self::PinData

Source§

impl LockPolicy<RawMutexStorage> for RawMutexStorage

Source§

type AcquireArgs = ()

Arguments passed when acquiring the lock under this policy.
Source§

type GuardState = ()

State stored in the pinned guard across lock acquisition and release.
Source§

unsafe fn acquire( lock: &RawMutexStorage, _state: &mut Self::GuardState, _args: (), )

Acquires the raw synchronization lock. Read more
Source§

unsafe fn reacquire(lock: &RawMutexStorage, state: &mut Self::GuardState)

Re-acquires the raw synchronization lock using existing guard state (e.g. after call_unlocked). Read more
Source§

unsafe fn release(lock: &RawMutexStorage, _state: &mut Self::GuardState)

Releases the raw synchronization lock, restoring the state. Read more
Source§

unsafe fn pre_validate( _lock: &L, _state: &mut Self::GuardState, _args: Self::AcquireArgs, )

Performs any pre-validation setup (such as disabling and saving interrupts) before lockdep validation runs. Read more
Source§

unsafe fn pre_reacquire(_lock: &L, _state: &mut Self::GuardState)

Re-runs pre-validation on an existing GuardState before re-acquiring the lock (e.g. in call_unlocked). Read more
Source§

unsafe fn post_validate_acquire( lock: &L, state: &mut Self::GuardState, args: Self::AcquireArgs, )

Acquires the raw synchronization lock after pre_validate and lockdep validation have completed. Read more
Source§

unsafe fn post_validate_reacquire(lock: &L, state: &mut Self::GuardState)

Re-acquires the raw synchronization lock after pre_reacquire and lockdep validation have completed. Read more
Source§

unsafe fn untrack(_lock: &L, _state: &mut Self::GuardState)

Temporarily untracks the held lock in lockdep (used by call_untracked). Read more
Source§

unsafe fn retrack(_lock: &L, _state: &mut Self::GuardState)

Re-tracks the held lock in lockdep after untrack (used by call_untracked). Read more
Source§

impl LockPolicy<RawMutexStorage> for RawCriticalMutexPolicy

Source§

type AcquireArgs = ()

Arguments passed when acquiring the lock under this policy.
Source§

type GuardState = bool

State stored in the pinned guard across lock acquisition and release.
Source§

unsafe fn acquire( lock: &RawMutexStorage, state: &mut Self::GuardState, _args: (), )

Acquires the raw synchronization lock. Read more
Source§

unsafe fn reacquire(lock: &RawMutexStorage, state: &mut Self::GuardState)

Re-acquires the raw synchronization lock using existing guard state (e.g. after call_unlocked). Read more
Source§

unsafe fn release(lock: &RawMutexStorage, should_clear: &mut Self::GuardState)

Releases the raw synchronization lock, restoring the state. Read more
Source§

unsafe fn pre_validate( _lock: &L, _state: &mut Self::GuardState, _args: Self::AcquireArgs, )

Performs any pre-validation setup (such as disabling and saving interrupts) before lockdep validation runs. Read more
Source§

unsafe fn pre_reacquire(_lock: &L, _state: &mut Self::GuardState)

Re-runs pre-validation on an existing GuardState before re-acquiring the lock (e.g. in call_unlocked). Read more
Source§

unsafe fn post_validate_acquire( lock: &L, state: &mut Self::GuardState, args: Self::AcquireArgs, )

Acquires the raw synchronization lock after pre_validate and lockdep validation have completed. Read more
Source§

unsafe fn post_validate_reacquire(lock: &L, state: &mut Self::GuardState)

Re-acquires the raw synchronization lock after pre_reacquire and lockdep validation have completed. Read more
Source§

unsafe fn untrack(_lock: &L, _state: &mut Self::GuardState)

Temporarily untracks the held lock in lockdep (used by call_untracked). Read more
Source§

unsafe fn retrack(_lock: &L, _state: &mut Self::GuardState)

Re-tracks the held lock in lockdep after untrack (used by call_untracked). Read more
Source§

impl PinnedDrop for RawMutexStorage

Source§

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

Executes the pinned destructor of this type. Read more
Source§

impl RawLock for RawMutexStorage

Source§

type DefaultPolicy = RawMutexStorage

Default policy that should be used when acquiring this lock.
Source§

unsafe fn init(_class_id: *const c_void) -> impl PinInit<Self, Infallible>

Returns a PinInit block to initialize the raw lock in-place. Read more
Source§

fn as_mut_ptr(&self) -> *mut c_void

Convert the raw lock reference to a standard c_void pointer for FFI.
Source§

impl Send for RawMutexStorage

Source§

impl Sync for RawMutexStorage

Auto Trait Implementations§

§

impl !Freeze for RawMutexStorage

§

impl !RefUnwindSafe for RawMutexStorage

§

impl UnsafeUnpin for RawMutexStorage

§

impl UnwindSafe for RawMutexStorage

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.