Struct AllGroups 

pub struct AllGroups { /* private fields */ }

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

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

Implementations

impl AllGroups

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

Create a new AllGroups.

pub fn add_group(&mut self, builder: GroupBuilder) -> Result<&Group, Error>

Consumes a builder, adding a new group to this AllGroups. Returns a reference to the created Group.

Make sure to call AllGroups::save in order for the new group to be applied to the system.

Defaults

If a builder is not passed a group id (GroupBuilder::gid) before being passed to this function, AllGroups::get_unique_id is used.

If the builder is not passed any users (GroupBuilder::user), the group will still be created.

pub fn save(&mut self) -> Result<(), Error>

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 as AllInner>::Gruser>

Get an iterator borrowing all Users or Groups on the system.

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

Get an iterator mutably borrowing all Users or Groups on the system.

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

Borrow the User or Group with a given name.

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

Mutable version of All::get_by_name.

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

Borrow the User or Group with the given ID.

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

Mutable version of All::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>) -> bool

Remove a User or Group from this All given it’s name. If the Gruser was removed return true, else return false. This ensures that the Gruser no longer exists.

fn remove_by_id(&mut self, id: usize) -> bool

Id version of All::remove_by_name.

impl Debug for AllGroups

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

Formats the value using the given formatter.