Struct sync::mutex::Mutex

source ·
pub struct Mutex<T: ?Sized> {
    std: Mutex<T>,
}
Expand description

A mutual exclusion primitive useful for protecting shared data.

Fields§

§std: Mutex<T>

Implementations§

source§

impl<T> Mutex<T>

source

pub const fn new(value: T) -> Mutex<T>

Creates a new mutex in an unlocked state ready for use.

source

pub fn into_inner(self) -> T

Consumes this mutex, returning the underlying data.

source§

impl<T: ?Sized> Mutex<T>

source

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

Acquires a mutex, blocking the current thread until it is able to do so.

This function will block the local thread until it is available to acquire the mutex. Upon returning, the thread is the only thread with the lock held. An RAII guard is returned to allow scoped unlock of the lock. When the guard goes out of scope, the mutex will be unlocked.

source

pub fn try_lock(&self) -> Result<MutexGuard<'_, T>, WouldBlock>

Attempts to acquire this lock.

If the lock could not be acquired at this time, then Err is returned. Otherwise, an RAII guard is returned. The lock will be unlocked when the guard is dropped.

This function does not block.

source

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

Returns a mutable reference to the underlying data.

Since this call borrows the Mutex mutably, no actual locking needs to take place – the mutable borrow statically guarantees no locks exist.

Trait Implementations§

source§

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

source§

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

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

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

source§

fn default() -> Mutex<T>

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

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

source§

fn from(value: T) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

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

Performs the conversion.
source§

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.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.