user_utils 0.3.0

Utility library for accessing system users and groups
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use std::ffi::OsString;
use std::fmt;
use std::io;
use std::ops;

#[cfg(unix)]
use crate::os::unix as os_impl;
#[cfg(windows)]
use crate::os::windows as os_impl;
use crate::private;
use crate::Error;

/// A new type pattern around a `borrowed` platform-native user id.
#[derive(PartialEq, Eq)]
pub struct Userid(os_impl::Userid);

impl Userid {
    /// Creates a new [`UseridBuf`] instance.
    #[inline]
    pub fn try_clone(&self) -> Result<UseridBuf, io::Error> {
        self.0.try_clone().map(UseridBuf)
    }

    /// Searches user database and returns the login name of user.
    pub fn name(&self) -> Result<OsString, Error> {
        self.0.name()
    }
}

impl fmt::Display for Userid {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl fmt::Debug for Userid {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}", self.0)
    }
}

impl PartialEq<UseridBuf> for Userid {
    fn eq(&self, other: &UseridBuf) -> bool {
        self.0 == other.0
    }
}

impl private::Sealed for Userid {}

#[cfg(unix)]
impl crate::os::unix::UseridExt for Userid {
    fn as_raw_uid(&self) -> libc::uid_t {
        self.0.as_raw_uid()
    }

    fn from_raw_uid(uid: &libc::uid_t) -> &Self {
        // SAFETY: Userid is just a wrapper around libc::uid_t.
        // therefore converting &libc::uid_t to &Userid is safe.
        unsafe { &*(uid as *const libc::uid_t as *const crate::os::unix::Userid as *const Userid) }
    }

    fn lookup_passwd(&self) -> Result<crate::os::unix::Passwd, Error> {
        self.0.lookup_passwd()
    }
}

#[cfg(windows)]
impl crate::os::windows::UseridExt for Userid {
    fn as_raw_psid(&self) -> os_impl::PSID {
        self.0.as_raw_psid()
    }

    fn from_raw_psid<'psid>(psid: os_impl::PSID) -> Option<&'psid Self> {
        let os_impl_userid = os_impl::Userid::from_raw_psid(psid)?;

        Some(unsafe { &*(os_impl_userid as *const crate::os::windows::Userid as *const Userid) })
    }

    unsafe fn from_raw_psid_unchecked<'psid>(psid: os_impl::PSID) -> &'psid Self {
        // SAFETY: Userid is just a wrapper around sys::PSID.
        // therefore converting sys::PSID to &Userid is safe.
        unsafe { &*(psid as *const crate::os::windows::Userid as *const Userid) }
    }
}

/// A new type pattern around an `owned` platform-native user id.
#[derive(PartialEq, Eq)]
pub struct UseridBuf(os_impl::UseridBuf);

impl fmt::Display for UseridBuf {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl fmt::Debug for UseridBuf {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}", self.0)
    }
}

impl PartialEq<Userid> for UseridBuf {
    fn eq(&self, other: &Userid) -> bool {
        self.0 == other.0
    }
}

impl ops::Deref for UseridBuf {
    type Target = Userid;

    fn deref(&self) -> &Self::Target {
        // SAFETY: Userid is just a wrapper around os_impl::Userid.
        // therefore converting &os_impl::Userid to &Userid is safe.
        unsafe { &*(self.0.deref() as *const os_impl::Userid as *const Userid) }
    }
}