Skip to content

docs(fs): Clarify That File::lock Coordinates Across Processes #153647

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

Merged
rust-bors merged 1 commit into from
Mar 23, 2026
+8 −6
Merged

docs(fs): Clarify That File::lock Coordinates Across Processes #153647

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions library/std/src/fs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,7 +815,8 @@ impl File {

/// Acquire an exclusive lock on the file. Blocks until the lock can be acquired.
///
/// This acquires an exclusive lock; no other file handle to this file may acquire another lock.
/// This acquires an exclusive lock; no other file handle to this file, in this or any other
/// process, may acquire another lock.
///
/// This lock may be advisory or mandatory. This lock is meant to interact with [`lock`],
/// [`try_lock`], [`lock_shared`], [`try_lock_shared`], and [`unlock`]. Its interactions with
Expand Down Expand Up @@ -868,8 +869,8 @@ impl File {

/// Acquire a shared (non-exclusive) lock on the file. Blocks until the lock can be acquired.
///
/// This acquires a shared lock; more than one file handle may hold a shared lock, but none may
/// hold an exclusive lock at the same time.
/// This acquires a shared lock; more than one file handle, in this or any other process, may
/// hold a shared lock, but none may hold an exclusive lock at the same time.
///
/// This lock may be advisory or mandatory. This lock is meant to interact with [`lock`],
/// [`try_lock`], [`lock_shared`], [`try_lock_shared`], and [`unlock`]. Its interactions with
Expand Down Expand Up @@ -923,7 +924,8 @@ impl File {
/// Returns `Err(TryLockError::WouldBlock)` if a different lock is already held on this file
/// (via another handle/descriptor).
///
/// This acquires an exclusive lock; no other file handle to this file may acquire another lock.
/// This acquires an exclusive lock; no other file handle to this file, in this or any other
/// process, may acquire another lock.
///
/// This lock may be advisory or mandatory. This lock is meant to interact with [`lock`],
/// [`try_lock`], [`lock_shared`], [`try_lock_shared`], and [`unlock`]. Its interactions with
Expand Down Expand Up @@ -987,8 +989,8 @@ impl File {
/// Returns `Err(TryLockError::WouldBlock)` if a different lock is already held on this file
/// (via another handle/descriptor).
///
/// This acquires a shared lock; more than one file handle may hold a shared lock, but none may
/// hold an exclusive lock at the same time.
/// This acquires a shared lock; more than one file handle, in this or any other process, may
/// hold a shared lock, but none may hold an exclusive lock at the same time.
///
/// This lock may be advisory or mandatory. This lock is meant to interact with [`lock`],
/// [`try_lock`], [`lock_shared`], [`try_lock_shared`], and [`unlock`]. Its interactions with
Expand Down
Loading