sync::Mutex: Add note about the absence of poisoning #1933
Merged
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
When porting code from
std::sync::Mutex
totokio::sync::Mutex
I noticed that thelock()
method does not return a result anymore.After a quick discussion in the #tokio-users discord channel, @sfackler confirmed that this mutex implementation does not poison the mutex on panic. That's probably a good default choice, but should be documented.
Solution
I added a note about the panic behavior to the
Mutex
rustdocs.