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.

Sign up for GitHub

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

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b3c89b
docs: Clarify FIFO Behavior of tokio::sync::Mutex
azuredream Jan 9, 2024
b516f88
docs: Clarify FIFO Behavior of tokio::sync::Mutex
azuredream Jan 9, 2024
c3773de
docs: Clarify FIFO Behavior of tokio::sync::Mutex
azuredream Jan 10, 2024
0d20c5e
Merge branch 'master' into MutexDocImprovment
azuredream Jan 10, 2024
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
4 changes: 4 additions & 0 deletions tokio/src/sync/mutex.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ 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.
///
/// 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.
///
/// # Which kind of mutex should you use?
///
/// Contrary to popular belief, it is ok and often preferred to use the ordinary
Expand Down
Loading