Struct priomutex::reservable::MutexGuard

pub struct MutexGuard<'a, T: ?Sized + 'a> { /* fields omitted */ }

An RAII guard. Frees the mutex when dropped.

While the guard is still valid, it can be dereferenced to access the data protected by the mutex. Attempting to dereference a guard which has been released will result in a panic!

Methods

impl<'a, T: ?Sized> MutexGuard<'a, T>

fn release_to(&mut self, thread_id: Option<ThreadId>)

Invalidate the guard and release the lock. If this lock has already been released, calling this function again does nothing.

• If no thread ID was specified: any other thread will be able to take the lock.
• If a thread ID was specified: only the specified thread will be able to take the lock.

It is not necessary to call this function yourself, since it will be run automatically when the guard goes out of scope.

Trait Implementations

impl<'a, T: ?Sized> Drop for MutexGuard<'a, T>

fn drop(&mut self)

Release the mutex, without reserving it for any particular thread.

impl<'a, T: ?Sized> Deref for MutexGuard<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Will panic if the guard has already been released via a call to release_to.

impl<'a, T: ?Sized> DerefMut for MutexGuard<'a, T>

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

Will panic if the guard has already been released via a call to release_to.