Update documentation to mention possibility of deadlock #3389
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Darksonn
added
A-tokio
carllerche
reviewed
Jan 19, 2021
| /// The calling task will yield until there are no writers which hold the | ||
| /// lock. There may be other readers inside the lock when the task resumes. | ||
| /// | ||
| /// Note that under the priority policy of [`RwLock`], read locks are not |
There was a problem hiding this comment.
It would be helpful to include a code example demonstrating the error.
carllerche
approved these changes
Jan 19, 2021
# Conflicts: # tokio/src/sync/rwlock.rs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Add detail about why deadlocks might be encountered when a read lock attempt is made following a successful read lock followed by a write lock attempt by the same task.
Solution
Update documentation in #2849