docs: Clarify FIFO Behavior of tokio::sync::Mutex #6279
Merged
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
Signed-off-by: azuredream <zhaozixuan67@gmail.com>
Signed-off-by: azuredream <zhaozixuan67@gmail.com>
Darksonn
added
T-docs
Darksonn
reviewed
Jan 10, 2024
tokio/src/sync/mutex.rs
Outdated
| @@ -17,6 +17,11 @@ use std::{fmt, mem, ptr}; | |||
| /// differences: [`lock`] is an async method so does not block, and the lock | |||
| /// guard is designed to be held across `.await` points. | |||
| /// | |||
| /// Please note that Tokio's Mutex operates on a guaranteed FIFO basis. | |||
There was a problem hiding this comment.
This is redundant.
Suggested change
| /// Please note that Tokio's Mutex operates on a guaranteed FIFO basis. | |
| /// Tokio's Mutex operates on a guaranteed FIFO basis. |
tokio/src/sync/mutex.rs
Outdated
| /// Please note that Tokio's Mutex operates on a guaranteed FIFO basis. | ||
| /// This means that the order in which tasks call the [`lock`] method is | ||
| /// the exact order in which they will acquire the lock. | ||
| /// We commit to maintaining this behavior in future versions. |
There was a problem hiding this comment.
This is generally implicit, so it's redundant to include it.
Suggested change
| /// We commit to maintaining this behavior in future versions. |
Signed-off-by: azuredream <zhaozixuan67@gmail.com>
|
Updated. Thanks for your review! |
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.
Closes: #6278