Skip to content

Reoganize poison::rwlock file #144175

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

connortsui20
Copy link
Contributor

This PR is a purely cosmetic change to the documentation and ordering of items in the rwlock.rs file.

This is mainly in preparation for the eventual implementation of #![feature(nonpoison_rwlock)] (which I am planning to do soon), and the issue for that can be found in #134645. These changes should make it easier to find things in the code and port things over to a future nonpoison variant of RwLock.

List of changes (lots of small things):

  • Clean up some of the existing field doc comments
  • Add documentation for every field in struct definitions
  • Consolidate related implementation blocks (1 implementation block per guard instead of 2)
  • Use the lifetime name 'rwlock instead of 'a
  • Reorder implementation blocks to be consistent across the entire file (follows the order ReadGuard, WriteGuard, MappedReadGuard, MappedWriteGuard)
  • Move simple trait implementations to the bottom of the file
  • Rename the poison field in MappedRwLockWriteGuard to posion_guard
  • Cut off comments at 100 columns
  • Update the documentation of downgrade to match Stabilize rwlock_downgrade library feature #143191

@rustbot
Copy link
Collaborator

rustbot commented Jul 19, 2025

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
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

@rustbot 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 Jul 19, 2025
@connortsui20 connortsui20 changed the title Reoganize rwlock file Reoganize poison::rwlock file Jul 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants