Struct User

pub struct User { /* private fields */ }

Information about a particular user.

For more information, see the module documentation.

Implementations

impl User

pub fn new<S: AsRef<OsStr> + ?Sized>( uid: uid_t, name: &S, primary_group: gid_t, ) -> Self

Create a new User with the given user ID, name, and primary group ID, with the rest of the fields filled with dummy values.

This method does not actually create a new user on the system — it should only be used for comparing users in tests.

Examples

use users::User;

let user = User::new(501, "stevedore", 100);

pub fn uid(&self) -> uid_t

Returns this user’s ID.

Examples

use users::User;

let user = User::new(501, "stevedore", 100);
assert_eq!(user.uid(), 501);

pub fn name(&self) -> &OsStr

Returns this user’s name.

Examples

use std::ffi::OsStr;
use users::User;

let user = User::new(501, "stevedore", 100);
assert_eq!(user.name(), OsStr::new("stevedore"));

pub fn primary_group_id(&self) -> gid_t

Returns the ID of this user’s primary group.

Examples

use users::User;

let user = User::new(501, "stevedore", 100);
assert_eq!(user.primary_group_id(), 100);

pub fn groups(&self) -> Option<Vec<Group>>

Returns a list of groups this user is a member of. This involves loading the groups list, as it is not contained within this type.

libc functions used

• getgrouplist

Examples

use users::User;

let user = User::new(501, "stevedore", 100);
for group in user.groups().expect("User not found") {
    println!("User is in group: {:?}", group.name());
}

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for User

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

Formats the value using the given formatter.

impl UserExt for User

fn home_dir(&self) -> &Path

Returns a path to this user’s home directory.

fn with_home_dir<S: AsRef<OsStr> + ?Sized>(self, home_dir: &S) -> Self

Sets this user value’s home directory to the given string. Can be used to construct test users, which by default come with a dummy home directory string.

fn shell(&self) -> &Path

Returns a path to this user’s shell.

fn with_shell<S: AsRef<OsStr> + ?Sized>(self, shell: &S) -> Self

Sets this user’s shell path to the given string. Can be used to construct test users, which by default come with a dummy shell field.

fn password(&self) -> &OsStr

Returns the user’s encrypted password.

fn with_password<S: AsRef<OsStr> + ?Sized>(self, password: &S) -> Self

Sets this user’s password to the given string. Can be used to construct tests users, which by default come with a dummy password field.