Skip to content

Add doc aliases for getpw{nam,uid} #2560

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
merged 1 commit into from
Dec 12, 2024
Merged

Add doc aliases for getpw{nam,uid} #2560

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
2 changes: 2 additions & 0 deletions src/unistd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3732,6 +3732,7 @@ impl User {
/// let res = User::from_uid(Uid::from_raw(0)).unwrap().unwrap();
/// assert_eq!(res.name, "root");
/// ```
#[doc(alias("getpwuid", "getpwuid_r"))]
pub fn from_uid(uid: Uid) -> Result<Option<Self>> {
// SAFETY: `getpwuid_r` will write to `res` if it initializes the value
// at `pwd`.
Expand All @@ -3755,6 +3756,7 @@ impl User {
/// let res = User::from_name("root").unwrap().unwrap();
/// assert_eq!(res.name, "root");
/// ```
#[doc(alias("getpwnam", "getpwnam_r"))]
pub fn from_name(name: &str) -> Result<Option<Self>> {
let name = match CString::new(name) {
Ok(c_str) => c_str,
Expand Down
Loading