diff options
| author | Tobias Bucher <tobiasbucher5991@gmail.com> | 2016-04-16 19:59:40 +0200 |
|---|---|---|
| committer | Tobias Bucher <tobiasbucher5991@gmail.com> | 2016-04-17 21:30:52 +0200 |
| commit | df748bf2934bf540ff9d7173781cbaf4986404fa (patch) | |
| tree | 852b90d3ba7888028d723cf61211917b338092d0 /src/libstd/sync | |
| parent | 6fa61b810dc95ca3e8bbda1681229f855f214fc4 (diff) | |
| download | rust-df748bf2934bf540ff9d7173781cbaf4986404fa.tar.gz rust-df748bf2934bf540ff9d7173781cbaf4986404fa.zip | |
Add a comment about locking a `Mutex` multiple times
Fixes #32260.
Diffstat (limited to 'src/libstd/sync')
| -rw-r--r-- | src/libstd/sync/mutex.rs | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/src/libstd/sync/mutex.rs b/src/libstd/sync/mutex.rs index 857a4cba9c7..21ce98f8748 100644 --- a/src/libstd/sync/mutex.rs +++ b/src/libstd/sync/mutex.rs @@ -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 { |
