Struct Mutex

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

Wrapper for std::sync::Mutex.

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

Implementations

impl<T> Mutex<T>

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

Create a new tracing mutex with the provided value.

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.

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.

pub fn is_poisoned(&self) -> bool

Wrapper for std::sync::Mutex::is_poisoned.

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.

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

Unwrap the mutex and return its inner value.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T: Default> Default for Mutex<T>

fn default() -> Mutex<T>

Returns the “default value” for a type.

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

fn from(t: T) -> Self

Converts to this type from the input type.