pub struct MutexGuard<'a, T, Lock>
where Lock: RawMutex,
{ /* private fields */ }
Expand description

An RAII implementation of a “scoped lock” of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.

The data protected by the mutex can be accessed through this guard via its Deref and DerefMut implementations.

This structure is created by the lock and try_lock methods on Mutex.

Trait Implementations§

§

impl<T, Lock, R> AsMut<R> for MutexGuard<'_, T, Lock>
where T: AsMut<R>, Lock: RawMutex, R: ?Sized,

§

fn as_mut(&mut self) -> &mut R

Converts this type into a mutable reference of the (usually inferred) input type.
§

impl<T, Lock, R> AsRef<R> for MutexGuard<'_, T, Lock>
where T: AsRef<R>, Lock: RawMutex, R: ?Sized,

§

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.
§

impl<T, Lock> Debug for MutexGuard<'_, T, Lock>
where T: Debug, Lock: RawMutex,

§

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

Formats the value using the given formatter. Read more
§

impl<T, Lock> Deref for MutexGuard<'_, T, Lock>
where Lock: RawMutex,

§

type Target = T

The resulting type after dereferencing.
§

fn deref(&self) -> &<MutexGuard<'_, T, Lock> as Deref>::Target

Dereferences the value.
§

impl<T, Lock> DerefMut for MutexGuard<'_, T, Lock>
where Lock: RawMutex,

§

fn deref_mut(&mut self) -> &mut <MutexGuard<'_, T, Lock> as Deref>::Target

Mutably dereferences the value.
§

impl<T, Lock> Display for MutexGuard<'_, T, Lock>
where T: Display, Lock: RawMutex,

§

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

Formats the value using the given formatter. Read more
§

impl<T, Lock> Drop for MutexGuard<'_, T, Lock>
where Lock: RawMutex,

§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

impl<T, Lock> Send for MutexGuard<'_, T, Lock>
where T: Send, Lock: RawMutex + Sync, <Lock as RawMutex>::GuardMarker: Send,

A MutexGuard is only Send if:

  1. the protected data (T) is Send, because the guard may be used to mutably access the protected data, and can therefore be used to move it using core::mem::replace or similar.
  2. the Lock type parameter is Sync, because the guard contains a reference to the Lock type, and therefore, sending the guard is sharing a reference to the Lock.
  3. the Lock type’s RawMutex::GuardMarker associated type is Send, because this indicates that the Lock type agrees that guards may be Send.

Auto Trait Implementations§

§

impl<'a, T, Lock> RefUnwindSafe for MutexGuard<'a, T, Lock>

§

impl<'a, T, Lock> !Sync for MutexGuard<'a, T, Lock>

§

impl<'a, T, Lock> Unpin for MutexGuard<'a, T, Lock>
where <Lock as RawMutex>::GuardMarker: Unpin,

§

impl<'a, T, Lock> UnwindSafe for MutexGuard<'a, T, Lock>

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<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more