Struct users::cache::UsersCache

pub struct UsersCache { /* fields omitted */ }

A producer of user and group instances that caches every result.

For more information, see the users::cache module documentation.

Implementations

impl UsersCache

pub fn new() -> Self

Creates a new empty cache.

Examples

use users::cache::UsersCache;

let cache = UsersCache::new();

pub unsafe fn with_all_users() -> Self

Creates a new cache that contains all the users present on the system.

Safety

This is unsafe because we cannot prevent data races if two caches were attempted to be initialised on different threads at the same time. For more information, see the all_users documentation.

Examples

use users::cache::UsersCache;

let cache = unsafe { UsersCache::with_all_users() };

Trait Implementations

impl Default for UsersCache

fn default() -> Self

Returns the "default value" for a type.

impl Groups for UsersCache

fn get_group_by_gid(&self, gid: gid_t) -> Option<Arc<Group>>

Returns a Group if one exists for the given group ID; otherwise, returns None.

fn get_group_by_name<S: AsRef<OsStr> + ?Sized>(
    &self,
    group_name: &S
) -> Option<Arc<Group>>

Returns a Group if one exists for the given groupname; otherwise, returns None.

fn get_current_gid(&self) -> gid_t

Returns the group ID for the user running the process.

fn get_current_groupname(&self) -> Option<Arc<OsStr>>

Returns the group name of the user running the process.

fn get_effective_gid(&self) -> gid_t

Returns the effective group id.

fn get_effective_groupname(&self) -> Option<Arc<OsStr>>

Returns the effective group name.

impl Users for UsersCache

fn get_user_by_uid(&self, uid: uid_t) -> Option<Arc<User>>

Returns a User if one exists for the given user ID; otherwise, returns None.

fn get_user_by_name<S: AsRef<OsStr> + ?Sized>(
    &self,
    username: &S
) -> Option<Arc<User>>

Returns a User if one exists for the given username; otherwise, returns None.

fn get_current_uid(&self) -> uid_t

Returns the user ID for the user running the process.

fn get_current_username(&self) -> Option<Arc<OsStr>>

Returns the username of the user running the process.

fn get_effective_uid(&self) -> uid_t

Returns the effective user id.

fn get_effective_username(&self) -> Option<Arc<OsStr>>

Returns the effective username.