cosmos::FileType Class Reference

Convenience wrapper around FileT. More...

#include <types.hxx>

Public Types
enum	FileT : mode_t {   NONE = 0 , SOCKET = S_IFSOCK , LINK = S_IFLNK , REGULAR = S_IFREG ,   BLOCKDEV = S_IFBLK , DIRECTORY = S_IFDIR , CHARDEV = S_IFCHR , FIFO = S_IFIFO }
	File type portion as found in a ModeT. More...

Public Member Functions
	FileType (const FileT raw)
	FileType (const ModeT raw)
bool	isRegular () const
bool	isDirectory () const
bool	isCharDev () const
bool	isBlockDev () const
bool	isFIFO () const
bool	isLink () const
bool	isSocket () const
auto	raw () const
char	symbolic () const
	Returns a symbolic character representing the type.
bool	operator== (const FileType &other) const
bool	operator!= (const FileType &other) const

Protected Attributes
FileT	m_raw

Detailed Description

Convenience wrapper around FileT.

Note

You won't need to set the FileType in any API call, you only need to check the FileType reported back from e.g. a stat() system call.

Definition at line 151 of file types.hxx.

Member Enumeration Documentation

FileT

enum cosmos::FileType::FileT : mode_t

File type portion as found in a ModeT.

Note that these are not bitmask values. Only one of the types can ever be set, no bitmask operations can be performed with this type.

These are the upper 4 bits of the st_mode field in struct stat. You can extract it using FileType.

TODO: This is now no class enum and thus no strong type. Using a strong type would be awkward, because we'd have something like OtherType::SOCKET, or FileType::Type::SOCKET. Once we reach C++20 we can use using enum OtherType within the FileType class which will solve the problem.

Enumerator
REGULAR	symbolic link

Definition at line 168 of file types.hxx.

                   : mode_t {
                NONE      = 0,
                SOCKET    = S_IFSOCK,
                LINK      = S_IFLNK, 
                REGULAR   = S_IFREG,
                BLOCKDEV  = S_IFBLK,
                DIRECTORY = S_IFDIR,
                CHARDEV   = S_IFCHR,
                FIFO      = S_IFIFO 
        };

Constructor & Destructor Documentation

FileType() [1/2]

cosmos::FileType::FileType ( const FileT raw )

inlineexplicit

Definition at line 180 of file types.hxx.

: m_raw{raw} {}

FileType() [2/2]

cosmos::FileType::FileType ( const ModeT raw )

inlineexplicit

Definition at line 182 of file types.hxx.

                                           :
                m_raw{static_cast<FileT>(raw & ModeT::MODE_T_TYPE_MASK)}
        {}

Member Function Documentation

isBlockDev()

bool cosmos::FileType::isBlockDev ( ) const

inline

Definition at line 189 of file types.hxx.

{ return m_raw == BLOCKDEV; }

isCharDev()

bool cosmos::FileType::isCharDev ( ) const

inline

Definition at line 188 of file types.hxx.

{ return m_raw == CHARDEV; }

isDirectory()

bool cosmos::FileType::isDirectory ( ) const

inline

Definition at line 187 of file types.hxx.

{ return m_raw == DIRECTORY; }

isFIFO()

bool cosmos::FileType::isFIFO ( ) const

inline

Definition at line 190 of file types.hxx.

{ return m_raw == FIFO; }

isLink()

bool cosmos::FileType::isLink ( ) const

inline

Definition at line 191 of file types.hxx.

{ return m_raw == LINK; }

isRegular()

bool cosmos::FileType::isRegular ( ) const

inline

Definition at line 186 of file types.hxx.

{ return m_raw == REGULAR;  }

isSocket()

bool cosmos::FileType::isSocket ( ) const

inline

Definition at line 192 of file types.hxx.

{ return m_raw == SOCKET; }

operator!=()

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

inline

Definition at line 207 of file types.hxx.

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

operator==()

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

inline

Definition at line 203 of file types.hxx.

                                                     {
                return m_raw == other.m_raw;
        }

raw()

auto cosmos::FileType::raw ( ) const

inline

Definition at line 194 of file types.hxx.

{ return m_raw; }

symbolic()

char cosmos::FileType::symbolic

(

)

const

Returns a symbolic character representing the type.

This returns a symbolic character like 'd' for directory as known from the ls utility and other tools.

Definition at line 87 of file FileStatus.cxx.

                              {
        switch(raw()) {
                default:        return '?';
                case NONE:      return '-';
                case SOCKET:    return 's';
                case LINK:      return 'l';
                case REGULAR:   return '-';
                case BLOCKDEV:  return 'b';
                case DIRECTORY: return 'd';
                case CHARDEV:   return 'c';
                case FIFO:      return 'p';
        }
}

Member Data Documentation

m_raw

FileT cosmos::FileType::m_raw

protected

Definition at line 213 of file types.hxx.

---

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

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