OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add a comment about locking a Mutex multiple times

Browse Source 
Fixes #32260.
This commit is contained in:
Tobias Bucher 2016-04-16 19:59:40 +02:00
parent 6fa61b810d
commit df748bf293
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/libstd/sync/mutex.rs
View File

@ -205,10 +205,19 @@ impl<T: ?Sized> Mutex<T> {
/// held. An RAII guard is returned to allow scoped unlock of the lock. When /// 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 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 /// # Errors
/// ///
/// If another user of this mutex panicked while holding the mutex, then /// If another user of this mutex panicked while holding the mutex, then
/// this call will return an error once the mutex is acquired. /// 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")] #[stable(feature = "rust1", since = "1.0.0")]
pub fn lock(&self) -> LockResult<MutexGuard<T>> { pub fn lock(&self) -> LockResult<MutexGuard<T>> {
unsafe { unsafe {