spinning_top::guard

Type Alias MappedBackoffSpinlockGuard

Source
pub type MappedBackoffSpinlockGuard<'a, T> = MappedMutexGuard<'a, RawSpinlock<Backoff>, T>;
Expand description

A RAII guard returned by BackoffSpinlockGuard::map.

§Example

use spinning_top::{
    guard::{BackoffSpinlockGuard, MappedBackoffSpinlockGuard},
    BackoffSpinlock,
};

let spinlock = BackoffSpinlock::new(Some(3));

// Begin a new scope.
{
    // Lock the spinlock to create a `BackoffSpinlockGuard`.
    let mut guard: BackoffSpinlockGuard<_> = spinlock.lock();

    // Map the internal value of `guard`. `guard` is moved.
    let mut mapped: MappedBackoffSpinlockGuard<'_, _> =
        BackoffSpinlockGuard::map(guard, |g| g.as_mut().unwrap());
    assert_eq!(*mapped, 3);

    *mapped = 5;
    assert_eq!(*mapped, 5);
} // `mapped` is dropped -> frees the spinlock again.

// The operation is reflected to the original lock.
assert_eq!(*spinlock.lock(), Some(5));

Aliased Type§

struct MappedBackoffSpinlockGuard<'a, T> { /* private fields */ }

Implementations

Source§

impl<'a, R, T> MappedMutexGuard<'a, R, T>
where R: RawMutex + 'a, T: 'a + ?Sized,

Source

pub fn map<U, F>( s: MappedMutexGuard<'a, R, T>, f: F, ) -> MappedMutexGuard<'a, R, U>
where F: FnOnce(&mut T) -> &mut U, U: ?Sized,

Makes a new MappedMutexGuard for a component of the locked data.

This operation cannot fail as the MappedMutexGuard passed in already locked the mutex.

This is an associated function that needs to be used as MappedMutexGuard::map(...). A method would interfere with methods of the same name on the contents of the locked data.

Source

pub fn try_map<U, F>( s: MappedMutexGuard<'a, R, T>, f: F, ) -> Result<MappedMutexGuard<'a, R, U>, MappedMutexGuard<'a, R, T>>
where F: FnOnce(&mut T) -> Option<&mut U>, U: ?Sized,

Attempts to make a new MappedMutexGuard for a component of the locked data. The original guard is returned if the closure returns None.

This operation cannot fail as the MappedMutexGuard passed in already locked the mutex.

This is an associated function that needs to be used as MappedMutexGuard::try_map(...). A method would interfere with methods of the same name on the contents of the locked data.

Source§

impl<'a, R, T> MappedMutexGuard<'a, R, T>
where R: RawMutexFair + 'a, T: 'a + ?Sized,

Source

pub fn unlock_fair(s: MappedMutexGuard<'a, R, T>)

Unlocks the mutex using a fair unlock protocol.

By default, mutexes are unfair and allow the current thread to re-lock the mutex before another has the chance to acquire the lock, even if that thread has been blocked on the mutex for a long time. This is the default because it allows much higher throughput as it avoids forcing a context switch on every mutex unlock. This can result in one thread acquiring a mutex many more times than other threads.

However in some cases it can be beneficial to ensure fairness by forcing the lock to pass on to a waiting thread if there is one. This is done by using this method instead of dropping the MutexGuard normally.

Trait Implementations

Source§

impl<'a, R, T> Debug for MappedMutexGuard<'a, R, T>
where R: RawMutex + 'a, T: Debug + 'a + ?Sized,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, R, T> Deref for MappedMutexGuard<'a, R, T>
where R: RawMutex + 'a, T: 'a + ?Sized,

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<'a, R, T> DerefMut for MappedMutexGuard<'a, R, T>
where R: RawMutex + 'a, T: 'a + ?Sized,

Source§

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

Mutably dereferences the value.
Source§

impl<'a, R, T> Display for MappedMutexGuard<'a, R, T>
where R: RawMutex + 'a, T: Display + 'a + ?Sized,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, R, T> Drop for MappedMutexGuard<'a, R, T>
where R: RawMutex + 'a, T: 'a + ?Sized,

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<'a, R, T> Send for MappedMutexGuard<'a, R, T>
where R: RawMutex + 'a, T: Send + 'a + ?Sized, <R as RawMutex>::GuardMarker: Send,

Source§

impl<'a, R, T> Sync for MappedMutexGuard<'a, R, T>
where R: RawMutex + Sync + 'a, T: Sync + 'a + ?Sized,