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

# Struct std::sync::MutexGuard 1.0.0 [−] [src]

    #[must_use]
    pub struct MutexGuard<'a, T: ?Sized + 'a> { /* fields omitted */ }

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<'a, T: ?Sized> !Send for MutexGuard<'a, T>`
[src]

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

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

#### `type Target = T`

The resulting type after dereferencing.

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn deref(&self) -> &T`
[src]

Dereferences the value.

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

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn deref_mut(&mut self) -> &mut T`
[src]

Mutably dereferences the value.

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

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

Executes the destructor for this type. Read more

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

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

Formats the value using the given formatter. Read more

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

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

Formats the value using the given formatter. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)