# tokio::sync::MutexGuard - Rust
API documentation for the Rust `MutexGuard` struct in crate `tokio`.
Keywords: rust, rustlang, rust-lang, MutexGuard

# Struct tokio::sync::MutexGuard [−] [src]

    pub struct MutexGuard<'a, T: ?Sized> { /* fields omitted */ }

A handle to a held `Mutex`.

As long as you have this guard, you have exclusive access to the underlying `T`. The guard internally borrows the `Mutex`, so the mutex will not be dropped while a guard exists.

The lock is automatically released whenever the guard is dropped, at which point `lock` will succeed yet again.

## Trait Implementations

### `impl<T: ?Sized + Debug> Debug for MutexGuard<'_, T>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<T: ?Sized> Deref for MutexGuard<'_, T>` [src]

#### `type Target = T`

The resulting type after dereferencing.

#### `fn deref(&self) -> &Self::Target` [src]

Dereferences the value.

### `impl<T: ?Sized> DerefMut for MutexGuard<'_, T>` [src]

#### `fn deref_mut(&mut self) -> &mut Self::Target` [src]

Mutably dereferences the value.

### `impl<T: ?Sized + Display> Display for MutexGuard<'_, T>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<T: ?Sized> Drop for MutexGuard<'_, T>` [src]

#### `fn drop(&mut self)` [src]

Executes the destructor for this type. Read more

### `impl<T: ?Sized> Sync for MutexGuard<'_, T> where
T: Send + Sync,` [src]

## Auto Trait Implementations

### `impl<'a, T> !RefUnwindSafe for MutexGuard<'a, T>` [src]

### `impl<'a, T: ?Sized> Send for MutexGuard<'a, T> where
T: Send,` [src]

### `impl<'a, T: ?Sized> Unpin for MutexGuard<'a, T>` [src]

### `impl<'a, T> !UnwindSafe for MutexGuard<'a, T>` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String` [src]

Converts the given value to a `String`. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.