pub struct Mutex<T> { /* private fields */ }
Expand description

Wrapper for std::sync::Mutex.

Refer to the crate-level documentation for the differences between this struct and the one it wraps.

Implementations§

source§

impl<T> Mutex<T>

source

pub const fn new(t: T) -> Self

Create a new tracing mutex with the provided value.

source

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

Wrapper for std::sync::Mutex::lock.

§Panics

This method participates in lock dependency tracking. If acquiring this lock introduces a dependency cycle, this method will panic.

source

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

Wrapper for std::sync::Mutex::try_lock.

§Panics

This method participates in lock dependency tracking. If acquiring this lock introduces a dependency cycle, this method will panic.

source

pub fn is_poisoned(&self) -> bool

source

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

Return a mutable reference to the underlying data.

This method does not block as the locking is handled compile-time by the type system.

source

pub fn into_inner(self) -> LockResult<T>

Unwrap the mutex and return its inner value.

Trait Implementations§

source§

impl<T: Debug> Debug for Mutex<T>

source§

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

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

impl<T: Default> 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(t: T) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Mutex<T>

§

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

§

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

§

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

§

impl<T> 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.