mirror of
https://github.com/rust-lang/rust.git
synced 2025-04-15 21:47:04 +00:00
RWLock: Add deadlock example
Suggested in https://github.com/rust-lang/rust/pull/82596 but it was a bit too late. Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
This commit is contained in:
parent
6e2801c44e
commit
98096a96c8
@ -25,7 +25,19 @@ use crate::sys_common::rwlock as sys;
|
||||
/// system's implementation, and this type does not guarantee that any
|
||||
/// particular policy will be used. In particular, a writer which is waiting to
|
||||
/// acquire the lock in `write` might or might not block concurrent calls to
|
||||
/// `read`.
|
||||
/// `read`, e.g.:
|
||||
///
|
||||
/// <details><summary>Potential deadlock example</summary>
|
||||
///
|
||||
/// ```text
|
||||
/// // Thread 1 | // Thread 2
|
||||
/// let _rg = lock.read(); |
|
||||
/// | // will block
|
||||
/// | let _wg = lock.write();
|
||||
/// // may deadlock |
|
||||
/// let _rg = lock.read(); |
|
||||
/// ```
|
||||
/// </details>
|
||||
///
|
||||
/// The type parameter `T` represents the data that this lock protects. It is
|
||||
/// required that `T` satisfies [`Send`] to be shared across threads and
|
||||
|
Loading…
Reference in New Issue
Block a user