Change signature of File::try_lock and File::try_lock_shared by cberner · Pull Request #139343 · rust-lang/rust

cberner · 2025-04-04T00:35:43Z

These methods now return Result<(), TryLockError> instead of Result<bool, Error> to make their use less errorprone

These methods are unstable under the "file_lock" feature. The related tracking issue is #130994 and this PR changes the signatures as discussed by libs-api: #130994 (comment)

rustbot · 2025-04-04T00:35:48Z

r? @Noratrieb

rustbot has assigned @Noratrieb.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

library/std/src/fs.rs

cberner · 2025-04-06T17:15:35Z

Ok, I pushed a new commit to address the comments and also made the docs a little more clear for TryLockError::WouldBlock

cberner · 2025-04-21T03:31:35Z

@Noratrieb anything I can do to help move this PR forward?

jieyouxu · 2025-04-25T17:17:14Z

r? libs

workingjubilee · 2025-04-30T23:33:43Z

Seems fine to me. People can continue to kibitz over what it should be if they want. @bors r+ rollup

bors · 2025-04-30T23:33:46Z

📌 Commit 7302f8e has been approved by workingjubilee

It is now in the queue for this repository.

…kingjubilee Change signature of File::try_lock and File::try_lock_shared These methods now return Result<(), TryLockError> instead of Result<bool, Error> to make their use less errorprone These methods are unstable under the "file_lock" feature. The related tracking issue is rust-lang#130999 and this PR changes the signatures as discussed by libs-api: rust-lang#130994 (comment)

Rollup of 11 pull requests Successful merges: - rust-lang#134034 (handle paren in macro expand for let-init-else expr) - rust-lang#138703 (chore: remove redundant words in comment) - rust-lang#139186 (Refactor `diy_float`) - rust-lang#139343 (Change signature of File::try_lock and File::try_lock_shared) - rust-lang#139780 (docs: Add example to `Iterator::take` with `by_ref`) - rust-lang#139802 (Fix some grammar errors and hyperlinks in doc for `trait Allocator`) - rust-lang#140034 (simd_select_bitmask: the 'padding' bits in the mask are just ignored) - rust-lang#140062 (std: mention `remove_dir_all` can emit `DirectoryNotEmpty` when concurrently written into) - rust-lang#140485 (Optimize the codegen for `Span::from_expansion`) - rust-lang#140505 (linker: Quote symbol names in .def files) - rust-lang#140521 (interpret: better error message for out-of-bounds pointer arithmetic and accesses) r? `@ghost` `@rustbot` modify labels: rollup

…kingjubilee Change signature of File::try_lock and File::try_lock_shared These methods now return Result<(), TryLockError> instead of Result<bool, Error> to make their use less errorprone These methods are unstable under the "file_lock" feature. The related tracking issue is rust-lang#130999 and this PR changes the signatures as discussed by libs-api: rust-lang#130994 (comment)

Rollup of 10 pull requests Successful merges: - rust-lang#134034 (handle paren in macro expand for let-init-else expr) - rust-lang#138703 (chore: remove redundant words in comment) - rust-lang#139186 (Refactor `diy_float`) - rust-lang#139343 (Change signature of File::try_lock and File::try_lock_shared) - rust-lang#139780 (docs: Add example to `Iterator::take` with `by_ref`) - rust-lang#139802 (Fix some grammar errors and hyperlinks in doc for `trait Allocator`) - rust-lang#140034 (simd_select_bitmask: the 'padding' bits in the mask are just ignored) - rust-lang#140062 (std: mention `remove_dir_all` can emit `DirectoryNotEmpty` when concurrently written into) - rust-lang#140485 (Optimize the codegen for `Span::from_expansion`) - rust-lang#140521 (interpret: better error message for out-of-bounds pointer arithmetic and accesses) r? `@ghost` `@rustbot` modify labels: rollup

…kingjubilee Change signature of File::try_lock and File::try_lock_shared These methods now return Result<(), TryLockError> instead of Result<bool, Error> to make their use less errorprone These methods are unstable under the "file_lock" feature. The related tracking issue is rust-lang#130999 and this PR changes the signatures as discussed by libs-api: rust-lang#130994 (comment)

…llaumeGomez Rollup of 12 pull requests Successful merges: - rust-lang#138703 (chore: remove redundant words in comment) - rust-lang#139186 (Refactor `diy_float`) - rust-lang#139343 (Change signature of File::try_lock and File::try_lock_shared) - rust-lang#139780 (docs: Add example to `Iterator::take` with `by_ref`) - rust-lang#139802 (Fix some grammar errors and hyperlinks in doc for `trait Allocator`) - rust-lang#140034 (simd_select_bitmask: the 'padding' bits in the mask are just ignored) - rust-lang#140062 (std: mention `remove_dir_all` can emit `DirectoryNotEmpty` when concurrently written into) - rust-lang#140420 (rustdoc: Fix doctest heuristic for main fn wrapping) - rust-lang#140460 (Fix handling of LoongArch target features not supported by LLVM 19) - rust-lang#140538 (rustc-dev-guide subtree update) - rust-lang#140552 (allow `#[rustc_std_internal_symbol]` in combination with `#[naked]`) - rust-lang#140556 (Improve error output in case `nodejs` or `npm` is not installed for rustdoc-gui test suite) r? `@ghost` `@rustbot` modify labels: rollup

GuillaumeGomez · 2025-05-01T20:26:36Z

Failed in #140562:

unused import: `TryLockError`
library/std/src/fs/tests.rs:4:53

@bors r-

workingjubilee · 2025-05-01T21:30:37Z

welp.

cberner · 2025-05-01T23:38:30Z

Oops, my bad. I missed the #[cfg] for that import. I fixed it now, and also added one to the check_would_block macro definition. @workingjubilee can I trouble you for another stamp?

cberner · 2025-05-02T00:32:18Z

@rustbot ready

library/std/src/fs/tests.rs

These methods now return Result<(), TryLockError> instead of Result<bool, Error> to make their use less errorprone

workingjubilee · 2025-05-02T20:59:12Z

Thanks! Let's try this again.

@bors r+ rollup

bors · 2025-05-02T20:59:28Z

📌 Commit 1d11ee2 has been approved by workingjubilee

It is now in the queue for this repository.

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#139343 (Change signature of File::try_lock and File::try_lock_shared) - rust-lang#140505 (linker: Quote symbol names in .def files) - rust-lang#140534 (PassWrapper: adapt for llvm/llvm-project@f137c3d592e96330e450a8fd63ef…) - rust-lang#140546 (Remove backtrace dep from anyhow in features status dump tool) - rust-lang#140548 (Emit user type annotations for free consts in pattern position) - rust-lang#140564 (Use present indicative tense in std::io::pipe() API docs) - rust-lang#140568 (Add regression test for rust-lang#140545) - rust-lang#140606 (Improve hir pretty printing) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#139343 - cberner:filelock_wouldblock, r=workingjubilee Change signature of File::try_lock and File::try_lock_shared These methods now return Result<(), TryLockError> instead of Result<bool, Error> to make their use less errorprone These methods are unstable under the "file_lock" feature. The related tracking issue is rust-lang#130999 and this PR changes the signatures as discussed by libs-api: rust-lang#130994 (comment)

…kingjubilee Change signature of File::try_lock and File::try_lock_shared These methods now return Result<(), TryLockError> instead of Result<bool, Error> to make their use less errorprone These methods are unstable under the "file_lock" feature. The related tracking issue is rust-lang#130999 and this PR changes the signatures as discussed by libs-api: rust-lang#130994 (comment)

The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`. The result type was changed in rust-lang#139343 after the latest change to the doc comments in rust-lang#136876.

Fix doc comment of File::try_lock and File::try_lock_shared The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`. The result type was changed in rust-lang#139343 after the latest change to the doc comments in rust-lang#136876.

Rollup merge of #145046 - ulrichstark:master, r=tgross35 Fix doc comment of File::try_lock and File::try_lock_shared The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`. The result type was changed in #139343 after the latest change to the doc comments in #136876.

Fix doc comment of File::try_lock and File::try_lock_shared The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`. The result type was changed in rust-lang/rust#139343 after the latest change to the doc comments in rust-lang/rust#136876.

Fix doc comment of File::try_lock and File::try_lock_shared The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`. The result type was changed in rust-lang#139343 after the latest change to the doc comments in rust-lang#136876.

Fix doc comment of File::try_lock and File::try_lock_shared The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`. The result type was changed in rust-lang/rust#139343 after the latest change to the doc comments in rust-lang/rust#136876.

Fix doc comment of File::try_lock and File::try_lock_shared The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`. The result type was changed in rust-lang#139343 after the latest change to the doc comments in rust-lang#136876.

Fix doc comment of File::try_lock and File::try_lock_shared The doc comments of functions `File::try_lock` and `File::try_lock_shared` stabilized today in version 1.89.0 document an incorrect type of `Ok`. The result type was changed in rust-lang/rust#139343 after the latest change to the doc comments in rust-lang/rust#136876.

rustbot assigned Noratrieb Apr 4, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Apr 4, 2025

juntyr reviewed Apr 4, 2025

View reviewed changes

library/std/src/fs.rs Show resolved Hide resolved

eric-seppanen reviewed Apr 5, 2025

View reviewed changes

library/std/src/fs.rs Show resolved Hide resolved

rustbot assigned workingjubilee and unassigned Noratrieb Apr 25, 2025

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 30, 2025

Zalathar mentioned this pull request May 1, 2025

Rollup of 11 pull requests #140541

Closed

Zalathar mentioned this pull request May 1, 2025

Rollup of 10 pull requests #140547

Closed

GuillaumeGomez mentioned this pull request May 1, 2025

Rollup of 12 pull requests #140562

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels May 1, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 2, 2025

workingjubilee reviewed May 2, 2025

View reviewed changes

library/std/src/fs/tests.rs Outdated Show resolved Hide resolved

cberner added 2 commits May 1, 2025 20:39

Change signature of File::try_lock and File::try_lock_shared

042a556

These methods now return Result<(), TryLockError> instead of Result<bool, Error> to make their use less errorprone

Implement error::Error for TryLockError

1d11ee2

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 2, 2025

matthiaskrgr mentioned this pull request May 3, 2025

Rollup of 8 pull requests #140608

Merged

bors merged commit 69e0844 into rust-lang:master May 3, 2025
6 checks passed

rustbot added this to the 1.88.0 milestone May 3, 2025

cberner mentioned this pull request May 4, 2025

Tracking Issue for File lock API #130994

Closed

6 tasks

ulrichstark mentioned this pull request Aug 7, 2025

Fix doc comment of File::try_lock and File::try_lock_shared #145046

Merged

Uh oh!

Conversation

cberner commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Apr 4, 2025

Uh oh!

Uh oh!

Uh oh!

cberner commented Apr 6, 2025

Uh oh!

cberner commented Apr 21, 2025

Uh oh!

jieyouxu commented Apr 25, 2025

Uh oh!

workingjubilee commented Apr 30, 2025

Uh oh!

bors commented Apr 30, 2025

Uh oh!

GuillaumeGomez commented May 1, 2025

Uh oh!

workingjubilee commented May 1, 2025

Uh oh!

cberner commented May 1, 2025

Uh oh!

cberner commented May 2, 2025

Uh oh!

Uh oh!

workingjubilee commented May 2, 2025

Uh oh!

bors commented May 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

cberner commented Apr 4, 2025 •

edited

Loading