Struct redox_users::AllGroups

pub struct AllGroups { /* fields omitted */ }

AllGroups provides (borrowed) access to all groups on the system. Note that this struct implements All, for a bunch of convenience functions.

General notes that also apply to this struct may be found with AllUsers.

Implementations

impl AllGroups

pub fn new(config: Config) -> Result<AllGroups>

Create a new AllGroups.

pub fn add_group(
    &mut self,
    name: &str,
    gid: usize,
    users: &[&str]
) -> Result<()>

Adds a group with the specified attributes to this AllGroups.

This function is classified as a mutating operation, and users must therefore call save in order for the new group to be applied to the system.

pub fn save(&self) -> Result<()>

Syncs the data stored in this AllGroups instance to the filesystem. To apply changes from an AllGroups, you MUST call this function!

Trait Implementations

impl All for AllGroups

fn iter(&self) -> Iter<'_, Self::Gruser>

Get an iterator borrowing all User's or Group's on the system.

fn iter_mut(&mut self) -> IterMut<'_, Self::Gruser>

Get an iterator mutably borrowing all User's or Group's on the system.

fn get_by_name(&self, name: impl AsRef<str>) -> Option<&Self::Gruser>

Borrow the User or Group with a given name.

fn get_mut_by_name(
    &mut self,
    name: impl AsRef<str>
) -> Option<&mut Self::Gruser>

Mutable version of get_by_name.

fn get_by_id(&self, id: usize) -> Option<&Self::Gruser>

Borrow the User or Group with the given ID.

fn get_mut_by_id(&mut self, id: usize) -> Option<&mut Self::Gruser>

Mutable version of get_by_id.

fn get_unique_id(&self) -> Option<usize>

Provides an unused id based on the min and max values in the Config passed to the All's constructor.

fn remove_by_name(&mut self, name: impl AsRef<str>)

Remove a User or Group from this All given it's name. This won't provide an indication of whether the user was removed or not, but is guaranteed to work if a user with the specified name exists.

fn remove_by_id(&mut self, id: usize)

Id version of remove_by_name.