Skip to content

Tracking issue for release notes of #130994: Tracking Issue for File lock API #136768

Open
@rustbot

Description

This issue tracks the release notes text for #130994.

Steps

  • Proposed text is drafted by PR author (or team) making the noteworthy change.
  • Issue is nominated for release team review of clarity for wider audience.
  • Release team includes text in release notes/blog posts.

Release notes text

The responsible team for the underlying change should edit this section to replace the automatically generated link with a succinct description of what changed, drawing upon text proposed by the author (either in discussion or through direct editing).

# Stabilized APIs
- [`File::lock`](https://doc.rust-lang.org/std/fs/struct.File.html#method.lock)
- [`File::lock_shared`](https://doc.rust-lang.org/std/fs/struct.File.html#method.lock_shared)
- [`File::try_lock`](https://doc.rust-lang.org/std/fs/struct.File.html#method.try_lock)
- [`File::try_lock_shared`](https://doc.rust-lang.org/std/fs/struct.File.html#method.try_lock_shared)
- [`File::unlock`](https://doc.rust-lang.org/std/fs/struct.File.html#method.unlock)

Tip

Use the previous releases categories to help choose which one(s) to use.
The category will be de-duplicated with all the other ones by the release team.

More than one section can be included if needed.

Release blog section

If the change is notable enough for inclusion in the blog post, the responsible team should add content to this section.
Otherwise leave it empty.

You can now lock a `File` using the standard library, without needing third-party crates. This is useful for coordinating access to files across cooperating processes. Use `File::lock` for an exclusive lock (blocking other exclusive or shared locks), or `File::lock_shared` for a shared lock (blocking exclusive locks). The lock will persist until the file handle or descriptor is closed, or you call `File::unlock`.

cc @cberner -- origin issue/PR authors and assignees for starting to draft text

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    I-release-nominatedNominated for the release team.T-libs-apiRelevant to the library API team, which will review and decide on the PR/issue.relnotesMarks issues that should be documented in the release notes of the next release.relnotes-tracking-issueMarks issues tracking what text to put in release notes.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions