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.

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

Overhaul examples for PermissionsExt #136001

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

Conversation

hkBst
Copy link
Member

@hkBst hkBst commented Jan 24, 2025

This fixes #91707 by including one overarching example, instead of the small examples that can be misleading.

/// );
///
/// // file mode that we want to add in
/// let my_mode = 0o007;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you have your octets reversed -- this is world RWX, but you say owner below.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely wrong indeed. Will fix.

///
/// permissions.set_mode(0o644); // Read/write for owner and read for others.
/// assert_eq!(permissions.mode(), 0o644);
/// Ok(())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, I think I prefer the original tighter examples. Can we just add f.set_permissions(..)?; here to solve the #91707 confusion?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've uplifted one of the small examples, which now also shows use of all three methods, but without a file in sight, so no confusion with file.set_permissions is possible. Best of both worlds?

@rustbot rustbot added O-unix Operating system: Unix-like T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jan 27, 2025
@hkBst
Copy link
Member Author

hkBst commented Jan 27, 2025

@rustbot labels: +A-docs

@rustbot rustbot added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Jan 27, 2025
@rust-log-analyzer

This comment has been minimized.

This fixes rust-lang#91707 by including one overarching example, instead of the small examples that can be misleading.
@hkBst hkBst requested a review from cuviper February 5, 2025 13:26
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools O-unix Operating system: Unix-like 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.

Documentation for PermissionsExt::set_mode should link to set_permissions
4 participants