SpinLockGuard

Struct SpinLockGuard 

Source
pub struct SpinLockGuard<'a, T>
where T: 'a + ?Sized,
{ caller: &'static Location<'static>, lock: &'a SpinLock<T>, guard: Option<InterruptGuard>, }
Expand description

An implementation of a “scoped lock” of a spinlock. When this structure is dropped (falls out of scope) without unlock, panic occurs.

The lock must be explicitly unlocked by unlock method.

The data protected by the mutex can be accessed through this guard.

This structure is created by the lock and try_lock methods on SpinLock.

Fields§

§caller: &'static Location<'static>§lock: &'a SpinLock<T>§guard: Option<InterruptGuard>

Implementations§

Source§

impl<T> SpinLockGuard<'_, T>
where T: ?Sized,

Source

pub fn unlock(self)

Releases the underlying SpinLock.

As the guard does not automatically release the lock on drop, the caller must explicitly invoke [unlock] to mark the lock as available again.

§Example
let lock = SpinLock::new(123);
let guard = lock.lock();

// Work with the locked data...

// Explicitly release the lock.
guard.unlock();

Trait Implementations§

Source§

impl<T> Deref for SpinLockGuard<'_, T>
where T: ?Sized,

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<T> DerefMut for SpinLockGuard<'_, T>
where T: ?Sized,

Source§

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

Mutably dereferences the value.
Source§

impl<T> Drop for SpinLockGuard<'_, T>
where T: ?Sized,

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<T> !Send for SpinLockGuard<'_, T>
where T: ?Sized,

Source§

impl<T> Sync for SpinLockGuard<'_, T>
where T: Sync + ?Sized,

Auto Trait Implementations§

§

impl<'a, T> Freeze for SpinLockGuard<'a, T>
where T: ?Sized,

§

impl<'a, T> !RefUnwindSafe for SpinLockGuard<'a, T>

§

impl<'a, T> Unpin for SpinLockGuard<'a, T>
where T: ?Sized,

§

impl<'a, T> !UnwindSafe for SpinLockGuard<'a, T>

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.

§

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.

§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.