logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

zipios::FilePath - FilePath represents a path to a file or directory name.

Author

       Generated automatically by Doxygen for Zipios++ from the source code.

Zipios++                                         Tue Mar 24 2020                             zipios::FilePath(3)

Constructor & Destructor Documentation

zipios::FilePath::FilePath(conststring&path='',boolcheck_exists=false)
       Constructor.

       Parameterspath A string representation of the path.
           check_exists If true is specified the constructor will check the existence and type of the path
           immidiately, instead of deferring that task until it is needed.

       Definition at line 18 of file filepath.cpp.

Detailed Description

FilePath represents a path to a file or directory name.

       FilePath has member functions to check if the file path is a valid file system entity, and to check what
       kind of file system entity it is, e.g. is it a file, a directory, a pipe etc.

       Definition at line 18 of file filepath.h.

Member Function Documentation

voidzipios::FilePath::check()const[protected]
       This function sets _checked to true, stats the path, to see if it exists and to determine what type of
       file it is. All the query functions check if _checked is true, and if it isn't they call check(). This
       means stat'ing is deferred until it becomes necessary.

       Definition at line 27 of file filepath.cpp.

   boolzipios::FilePath::exists()const[inline]Returns
           true If the path is a valid file system entity.

       Definition at line 129 of file filepath.h.

   FilePathzipios::FilePath::filename()const[inline]
       Returns filename of the FilePath object by pruning the path off.

       Definition at line 119 of file filepath.h.

   boolzipios::FilePath::isBlockSpecial()const[inline]Returns
           true if the path is block special (a block device file).

       Definition at line 157 of file filepath.h.

   boolzipios::FilePath::isCharSpecial()const[inline]Returns
           true if the path is character special (a character device file).

       Definition at line 150 of file filepath.h.

   boolzipios::FilePath::isDirectory()const[inline]Returns
           true if the path is a directory.

       Definition at line 143 of file filepath.h.

   boolzipios::FilePath::isFifo()const[inline]Returns
           true if the path is a Fifo (a pipe).

       Definition at line 171 of file filepath.h.

   boolzipios::FilePath::isRegular()const[inline]Returns
           true if the path is a regular file.

       Definition at line 136 of file filepath.h.

   boolzipios::FilePath::isSocket()const[inline]Returns
           true if the path is a socket.

       Definition at line 164 of file filepath.h.

   FilePathzipios::FilePath::operator+(constFilePath&name)const[inline]
       Concatenates FilePath objects. A file separator is inserted if appropriate.

       Definition at line 111 of file filepath.h.

   voidzipios::FilePath::pruneTrailingSeparator()[inline],[protected]
       Prunes the trailing separator of a specified path.

       Definition at line 100 of file filepath.h.

Name

       zipios::FilePath - FilePath represents a path to a file or directory name.

Synopsis

       #include <filepath.h>

   PublicMemberFunctionsFilePath (const string &path='', bool check_exists=false)
           Constructor.
       FilePath & operator= (const string &rhs)
       operatorstring () const
       FilePathoperator+ (const FilePath &name) const
           Concatenates FilePath objects.
       FilePathfilename () const
           Returns filename of the FilePath object by pruning the path off.
       bool exists () const
       bool isRegular () const
       bool isDirectory () const
       bool isCharSpecial () const
       bool isBlockSpecial () const
       bool isSocket () const
       bool isFifo () const

   ProtectedMemberFunctions
       void pruneTrailingSeparator ()
           Prunes the trailing separator of a specified path.
       void check () const
           This function sets _checked to true, stats the path, to see if it exists and to determine what type
           of file it is.

   ProtectedAttributes
       bool _checked
       bool _exists
       bool _is_reg
       bool _is_dir
       bool _is_char
       bool _is_block
       bool _is_socket
       bool _is_fifo
       string _pathStaticProtectedAttributes
       static const char _separator = '/'

See Also