Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Clarify FIFO Behavior of tokio::sync::Mutex #6279

Merged
merged 4 commits into from
Jan 11, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions tokio/src/sync/mutex.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

/// 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is generally implicit, so it's redundant to include it.

Suggested change
/// We commit to maintaining this behavior in future versions.

///
/// # Which kind of mutex should you use?
///
/// Contrary to popular belief, it is ok and often preferred to use the ordinary
Expand Down
Loading