jaulib v1.3.0
Jau Support Library (C++, Java, ..)
Public Types | Public Member Functions | List of all members
jau::os::UserInfo Class Reference

User account information of the underlying OS. More...

#include <user_info.hpp>

Collaboration diagram for jau::os::UserInfo:

Public Types

typedef uint64_t id_t
 

Public Member Functions

 UserInfo () noexcept
 Create instance of the user executing this application. More...
 
 UserInfo (const std::string &username) noexcept
 Create instance of the given user name. More...
 
 UserInfo (id_t uid) noexcept
 Create instance of the given user id. More...
 
id_t gid () const noexcept
 
const std::vector< id_t > & groups () const noexcept
 
const std::string & homedir () const noexcept
 
bool isValid () const noexcept
 
const std::string & shell () const noexcept
 
std::string toString () const noexcept
 
id_t uid () const noexcept
 
const std::string & username () const noexcept
 

Detailed Description

User account information of the underlying OS.

Definition at line 42 of file user_info.hpp.

Member Typedef Documentation

◆ id_t

typedef uint64_t jau::os::UserInfo::id_t

Definition at line 44 of file user_info.hpp.

Constructor & Destructor Documentation

◆ UserInfo() [1/3]

UserInfo::UserInfo ( )
noexcept

Create instance of the user executing this application.

Definition at line 191 of file user_info.cpp.

◆ UserInfo() [2/3]

UserInfo::UserInfo ( id_t  uid)
noexcept

Create instance of the given user id.

Definition at line 198 of file user_info.cpp.

◆ UserInfo() [3/3]

UserInfo::UserInfo ( const std::string &  username)
noexcept

Create instance of the given user name.

Definition at line 206 of file user_info.cpp.

Member Function Documentation

◆ isValid()

bool jau::os::UserInfo::isValid ( ) const
inlinenoexcept

Definition at line 77 of file user_info.hpp.

Here is the caller graph for this function:

◆ uid()

id_t jau::os::UserInfo::uid ( ) const
inlinenoexcept

Definition at line 78 of file user_info.hpp.

Here is the caller graph for this function:

◆ gid()

id_t jau::os::UserInfo::gid ( ) const
inlinenoexcept

Definition at line 79 of file user_info.hpp.

Here is the caller graph for this function:

◆ username()

const std::string & jau::os::UserInfo::username ( ) const
inlinenoexcept

Definition at line 80 of file user_info.hpp.

Here is the caller graph for this function:

◆ homedir()

const std::string & jau::os::UserInfo::homedir ( ) const
inlinenoexcept

Definition at line 81 of file user_info.hpp.

Here is the caller graph for this function:

◆ shell()

const std::string & jau::os::UserInfo::shell ( ) const
inlinenoexcept

Definition at line 82 of file user_info.hpp.

Here is the caller graph for this function:

◆ groups()

const std::vector< id_t > & jau::os::UserInfo::groups ( ) const
inlinenoexcept

Definition at line 83 of file user_info.hpp.

Here is the caller graph for this function:

◆ toString()

std::string jau::os::UserInfo::toString ( ) const
inlinenoexcept

Definition at line 85 of file user_info.hpp.

Here is the caller graph for this function:

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