cosmos::GroupInfo Class Reference

Group Database Information. More...

#include <GroupInfo.hxx>

Inheritance diagram for cosmos::GroupInfo:

Public Member Functions
	GroupInfo (const SysString name)
	Obtains GroupInfo for the given group name name.
	GroupInfo (const GroupID gid)
	Obtains GroupInfo for the given numerical group id gid.
GroupID	gid () const
	The groups numerical ID.
SysString	name () const
	Returns the name associated with the group.
SysString	passwd () const
	Returns the optional encrypted group password.
SysStringVector	members () const
	Returns a vector containing the name of users that are members of this group.
Public Member Functions inherited from cosmos::InfoBase< struct group >
bool	valid () const
	Returns whether data is present in the object.
void	reset ()
	Zeroes out all data.
const struct group *	raw () const
	Grants access to the raw underlying data structure.
struct group *	raw ()

Additional Inherited Members
Protected Member Functions inherited from cosmos::InfoBase< struct group >
bool	getInfo (std::function< int(struct group **)> get_func, const char *errlabel)
	Helper to drive the common getter function logic for getpw* and getgr*.
Protected Attributes inherited from cosmos::InfoBase< struct group >
bool	m_valid
struct group	m_info
	struct passwd or struct group.
std::vector< char >	m_buf
	Extra space for storing the dynamic strings in the m_info struct.

Detailed Description

Group Database Information.

This type obtains and stores data for an individual group account ID as found in the /etc/group database.

Definition at line 22 of file GroupInfo.hxx.

Constructor & Destructor Documentation

GroupInfo() [1/2]

cosmos::GroupInfo::GroupInfo ( const SysString name )

explicit

Obtains GroupInfo for the given group name name.

Definition at line 9 of file GroupInfo.cxx.

                                         {
        auto call = [&](struct group **res) -> int {
                return getgrnam_r(name.raw(), &m_info,
                                m_buf.data(), m_buf.size(),
                                res);
        };
 
        m_valid = getInfo(call, "getgrnam_r()");
 
        if (!m_valid)
                reset();
}

GroupInfo() [2/2]

cosmos::GroupInfo::GroupInfo ( const GroupID gid )

explicit

Obtains GroupInfo for the given numerical group id gid.

Definition at line 22 of file GroupInfo.cxx.

                                      {
        auto call = [&](struct group **res) -> int {
                return getgrgid_r(to_integral(gid), &m_info,
                                m_buf.data(), m_buf.size(),
                                res);
        };
 
        m_valid = getInfo(call, "getgrgid_r()");
        if (!m_valid)
                reset();
}

Member Function Documentation

gid()

GroupID cosmos::GroupInfo::gid ( ) const

inline

The groups numerical ID.

Definition at line 33 of file GroupInfo.hxx.

{ return GroupID{m_info.gr_gid}; }

members()

SysStringVector cosmos::GroupInfo::members

(

)

const

Returns a vector containing the name of users that are members of this group.

Definition at line 34 of file GroupInfo.cxx.

                                         {
        if (!valid()) {
                cosmos_throw (UsageError{"cannot get members of invalid GroupInfo"});
        }
 
        SysStringVector ret;
 
        for (char **member = m_info.gr_mem; *member != nullptr; member++) {
                ret.push_back(*member);
        }
 
        return ret;
}

name()

SysString cosmos::GroupInfo::name ( ) const

inline

Returns the name associated with the group.

Definition at line 36 of file GroupInfo.hxx.

{ return SysString{m_info.gr_name}; }

passwd()

SysString cosmos::GroupInfo::passwd ( ) const

inline

Returns the optional encrypted group password.

Definition at line 39 of file GroupInfo.hxx.

{ return SysString{m_info.gr_passwd}; }

---

The documentation for this class was generated from the following files:

• include/GroupInfo.hxx
• src/GroupInfo.cxx