Skip to content

Commit

Permalink
Auto merge of rust-lang#33034 - tbu-:pr_doc_mutex_lock, r=nagisa
Browse files Browse the repository at this point in the history
Add a comment about locking a `Mutex` multiple times

Fixes rust-lang#32260.
  • Loading branch information
bors committed Apr 17, 2016
2 parents 412e6f7 + df748bf commit ed7c567
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/libstd/sync/mutex.rs
Original file line number Diff line number Diff line change
Expand Up @@ -205,10 +205,19 @@ impl<T: ?Sized> Mutex<T> {
/// held. An RAII guard is returned to allow scoped unlock of the lock. When
/// the guard goes out of scope, the mutex will be unlocked.
///
/// The exact behavior on locking a mutex in the thread which already holds
/// the lock is left unspecified, however, this function will not return on
/// the second call, it might e.g. panic or deadlock.
///
/// # Errors
///
/// If another user of this mutex panicked while holding the mutex, then
/// this call will return an error once the mutex is acquired.
///
/// # Panics
///
/// This function might panic when called if the lock is already held by
/// the current thread.
#[stable(feature = "rust1", since = "1.0.0")]
pub fn lock(&self) -> LockResult<MutexGuard<T>> {
unsafe {
Expand Down

0 comments on commit ed7c567

Please sign in to comment.