Struct peace_lock::Mutex

pub struct Mutex<T: ?Sized> { /* private fields */ }

A mutual exclusive lock

Implementations

impl<T> Mutex<T>

pub fn new(val: T) -> Self

Create a new Mutex.

pub fn into_inner(self) -> T

Consume the Mutex, returning the inner value.

impl<T> Mutex<T>where T: ?Sized,

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference of the inner value T. This is safe because we have the mutable reference of the lock.

pub fn try_lock<'a>(&'a self) -> Option<MutexGuard<'a, T>>

Try lock the Mutex, returns the mutex guard. Returns None if the Mutex is write locked.

pub fn lock<'a>(&'a self) -> MutexGuard<'a, T>

Lock the Mutex, returns the mutex guard.

Panics

If the Mutex is already locked, this will panic if the check feature is turned on.

Trait Implementations

impl<T: Debug + ?Sized> Debug for Mutex<T>

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

Formats the value using the given formatter.

impl<T> Default for Mutex<T>where T: ?Sized + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<T> for Mutex<T>

fn from(val: T) -> Self

Converts to this type from the input type.

impl<T> RefUnwindSafe for Mutex<T>where T: ?Sized,

impl<T> Send for Mutex<T>where T: ?Sized + Send,

impl<T> Sync for Mutex<T>where T: ?Sized + Send,

impl<T> UnwindSafe for Mutex<T>where T: ?Sized,