cosmos::FileMode Class Reference

Represents the mode bits portion of a ModeT. More...

#include <types.hxx>

Public Member Functions
	FileMode (const FileModeBits mask)
	Constructs a FileMode from the given bitmask object.
	FileMode (const ModeT raw=ModeT::NONE)
	Constructs a FileMode from the given raw input.
bool	isSetUID () const
bool	isSetGID () const
bool	isSticky () const
bool	canOwnerRead () const
bool	canOwnerWrite () const
bool	canOwnerExec () const
bool	canGroupRead () const
bool	canGroupWrite () const
bool	canGroupExec () const
bool	canOthersRead () const
bool	canOthersWrite () const
bool	canOthersExec () const
bool	canAnyRead () const
bool	canAnyWrite () const
bool	canAnyExec () const
FileModeBits &	mask ()
	Returns the complete bitmask object.
const FileModeBits &	mask () const
std::string	symbolic () const
	Returns a symbolic string representation of the mode.
ModeT	raw () const
bool	operator== (const FileMode &other) const
bool	operator!= (const FileMode &other) const

Protected Attributes
FileModeBits	m_mode
	bitmask for mode bits

Detailed Description

Represents the mode bits portion of a ModeT.

This is wrapper around the primitive ModeT describing the classical UNIX file permissions and mode bits.

Definition at line 221 of file types.hxx.

Constructor & Destructor Documentation

FileMode() [1/2]

cosmos::FileMode::FileMode ( const FileModeBits mask )

inlineexplicit

Constructs a FileMode from the given bitmask object.

Definition at line 224 of file types.hxx.

                                                   :
                m_mode{mask}
        {}

FileMode() [2/2]

cosmos::FileMode::FileMode ( const ModeT raw = ModeT::NONE )

inline

Constructs a FileMode from the given raw input.

• can be used to specify a literal: FileMode{ModeT{0751}}
• or to pass in a mode_t received from a system call (struct stat)

This constructor is consciously not explicit to allow simpler use of octal literals.

Definition at line 236 of file types.hxx.

                                              :
                m_mode{static_cast<FileModeBit>(raw & ModeT::MODE_T_MODE_MASK)}
        {}

Member Function Documentation

canAnyExec()

bool cosmos::FileMode::canAnyExec ( ) const

inline

Definition at line 270 of file types.hxx.

                                {
                return m_mode.anyOf({
                                FileModeBit::OWNER_EXEC,
                                FileModeBit::GROUP_EXEC,
                                FileModeBit::OTHER_EXEC});
        }

canAnyRead()

bool cosmos::FileMode::canAnyRead ( ) const

inline

Definition at line 256 of file types.hxx.

                                {
                return m_mode.anyOf({
                                FileModeBit::OWNER_READ,
                                FileModeBit::GROUP_READ,
                                FileModeBit::OTHER_READ});
        }

canAnyWrite()

bool cosmos::FileMode::canAnyWrite ( ) const

inline

Definition at line 263 of file types.hxx.

                                 {
                return m_mode.anyOf({
                                FileModeBit::OWNER_WRITE,
                                FileModeBit::GROUP_WRITE,
                                FileModeBit::OTHER_WRITE});
        }

canGroupExec()

bool cosmos::FileMode::canGroupExec ( ) const

inline

Definition at line 250 of file types.hxx.

{ return m_mode[FileModeBit::GROUP_EXEC]; }

canGroupRead()

bool cosmos::FileMode::canGroupRead ( ) const

inline

Definition at line 248 of file types.hxx.

{ return m_mode[FileModeBit::GROUP_READ]; }

canGroupWrite()

bool cosmos::FileMode::canGroupWrite ( ) const

inline

Definition at line 249 of file types.hxx.

{ return m_mode[FileModeBit::GROUP_WRITE]; }

canOthersExec()

bool cosmos::FileMode::canOthersExec ( ) const

inline

Definition at line 254 of file types.hxx.

{ return m_mode[FileModeBit::OTHER_EXEC]; }

canOthersRead()

bool cosmos::FileMode::canOthersRead ( ) const

inline

Definition at line 252 of file types.hxx.

{ return m_mode[FileModeBit::OTHER_READ]; }

canOthersWrite()

bool cosmos::FileMode::canOthersWrite ( ) const

inline

Definition at line 253 of file types.hxx.

{ return m_mode[FileModeBit::OTHER_WRITE]; }

canOwnerExec()

bool cosmos::FileMode::canOwnerExec ( ) const

inline

Definition at line 246 of file types.hxx.

{ return m_mode[FileModeBit::OWNER_EXEC]; }

canOwnerRead()

bool cosmos::FileMode::canOwnerRead ( ) const

inline

Definition at line 244 of file types.hxx.

{ return m_mode[FileModeBit::OWNER_READ]; }

canOwnerWrite()

bool cosmos::FileMode::canOwnerWrite ( ) const

inline

Definition at line 245 of file types.hxx.

{ return m_mode[FileModeBit::OWNER_WRITE]; }

isSetGID()

bool cosmos::FileMode::isSetGID ( ) const

inline

Definition at line 241 of file types.hxx.

{ return m_mode[FileModeBit::SETGID]; }

isSetUID()

bool cosmos::FileMode::isSetUID ( ) const

inline

Definition at line 240 of file types.hxx.

{ return m_mode[FileModeBit::SETUID]; }

isSticky()

bool cosmos::FileMode::isSticky ( ) const

inline

Definition at line 242 of file types.hxx.

{ return m_mode[FileModeBit::STICKY]; }

mask() [1/2]

FileModeBits & cosmos::FileMode::mask ( )

inline

Returns the complete bitmask object.

Definition at line 278 of file types.hxx.

{ return m_mode; }

mask() [2/2]

const FileModeBits & cosmos::FileMode::mask ( ) const

inline

Definition at line 279 of file types.hxx.

{ return m_mode; }

operator!=()

bool cosmos::FileMode::operator!= ( const FileMode & other ) const

inline

Definition at line 295 of file types.hxx.

                                                     {
                return !(*this == other);
        }

operator==()

bool cosmos::FileMode::operator== ( const FileMode & other ) const

inline

Definition at line 291 of file types.hxx.

                                                     {
                return m_mode == other.m_mode;
        }

raw()

ModeT cosmos::FileMode::raw ( ) const

inline

Definition at line 289 of file types.hxx.

{ return ModeT{m_mode.raw()}; }

symbolic()

std::string cosmos::FileMode::symbolic

(

)

const

Returns a symbolic string representation of the mode.

This returns a string like "r-x---r-x" as known from the ls utility and similar tools. The type is not part of this. You can use FileType::symbolic() to also get the type character in front.

Definition at line 51 of file FileStatus.cxx.

                                   {
        std::string ret;
 
        if (canOwnerRead()) ret.push_back('r');
        else ret.push_back('-');
 
        if (canOwnerWrite()) ret.push_back('w');
        else ret.push_back('-');
 
        if (isSetUID()) ret.push_back('s');
        else if (canOwnerExec()) ret.push_back('x');
        else ret.push_back('-');
 
        if (canGroupRead()) ret.push_back('r');
        else ret.push_back('-');
 
        if (canGroupWrite()) ret.push_back('w');
        else ret.push_back('-');
 
        if (isSetGID()) ret.push_back('s');
        else if (canGroupExec()) ret.push_back('x');
        else ret.push_back('-');
 
        if (canOthersRead()) ret.push_back('r');
        else ret.push_back('-');
 
        if (canOthersWrite()) ret.push_back('w');
        else ret.push_back('-');
 
        if (isSticky()) ret.push_back('t');
        else if(canOthersExec()) ret.push_back('x');
        else ret.push_back('-');
 
        return ret;
}

Member Data Documentation

m_mode

FileModeBits cosmos::FileMode::m_mode

protected

bitmask for mode bits

Definition at line 302 of file types.hxx.

---

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

• include/fs/types.hxx
• src/fs/FileStatus.cxx