Struct pwd_grp::PwdGrp

pub struct PwdGrp;

Provider of passwd and group information, from system databases

The actual functionality is provided by methods of PwdGrpProvider.

These are generic over the returned string type. This enables working with non-UTF-8 data in passwd/group files, and also with Box<str>. If you just want to work with String, use the plain functions in the module toplevel.

Examples

use pwd_grp::Passwd;
use pwd_grp::PwdGrpProvider as _;
use pwd_grp::PwdGrp;

let pwent: Passwd<Vec<u8>> = PwdGrp.getpwuid(0).unwrap().unwrap();
assert_eq!(pwent.uid, 0);
match std::str::from_utf8(&pwent.gecos) {
    Ok(s) => println!("root user gecos: {}", s),
    Err(_) => println!("root user gecos is not valid UTF-8"),
}

Trait Implementations

impl Clone for PwdGrp

fn clone(&self) -> PwdGrp

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PwdGrp

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PwdGrp

fn default() -> PwdGrp

Returns the “default value” for a type.

impl Hash for PwdGrp

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PwdGrp

fn cmp(&self, other: &PwdGrp) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PwdGrp> for PwdGrp

fn eq(&self, other: &PwdGrp) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<PwdGrp> for PwdGrp

fn partial_cmp(&self, other: &PwdGrp) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PwdGrpProvider for PwdGrp

fn getpwnam<S: PwdGrpString>( &self, name: impl AsRef<<S as Deref>::Target> ) -> Result<Option<Passwd<S>>>

Look up a passwd entry by name, returning strings as S

fn getpwuid<S: PwdGrpString>(&self, uid: uid_t) -> Result<Option<Passwd<S>>>

Look up a passwd entry by uid, returning strings as S

fn getgrnam<S: PwdGrpString>( &self, name: impl AsRef<<S as Deref>::Target> ) -> Result<Option<Group<S>>>

Look up a group entry by name, returning strings as S

fn getgrgid<S: PwdGrpString>(&self, gid: uid_t) -> Result<Option<Group<S>>>

Look up a group entry by gid, returning strings as S

fn getuid(&self) -> uid_t

Get the current process’s (real) uid

fn geteuid(&self) -> uid_t

Get the current process’s effective uid

fn getresuid(&self) -> (uid_t, uid_t, uid_t)

Get the current process’s real, effective and saved set-uid

fn getgid(&self) -> uid_t

Get the current process’s (real) gid

fn getegid(&self) -> uid_t

Get the current process’s effective gid

fn getresgid(&self) -> (uid_t, uid_t, uid_t)

Get the current process’s real, effective and saved set-gid

fn getgroups(&self) -> Result<Vec<uid_t>>

Get the current process’s supplementary group list

impl Eq for PwdGrp

impl StructuralEq for PwdGrp

impl StructuralPartialEq for PwdGrp