cppfs  1.2.0.5b71c2c98fb9
Cross-platform C++ file system library supporting multiple backends (Local-FS, SSH)
Public Member Functions | Protected Member Functions | Friends | List of all members
cppfs::FileVisitor Class Reference

File visitor. More...

#include <cppfs/include/cppfs/FileVisitor.h>

Inheritance diagram for cppfs::FileVisitor:
Inheritance graph
[legend]

Public Member Functions

 FileVisitor ()
 Constructor. More...
 
virtual ~FileVisitor ()
 Destructor. More...
 

Protected Member Functions

virtual bool onFileEntry (FileHandle &fh)
 Called on each file entry (files and directories) More...
 
virtual bool onFile (FileHandle &fh)
 Called on each file. More...
 
virtual bool onDirectory (FileHandle &fh)
 Called on each directory. More...
 

Friends

class FileHandle
 

Detailed Description

File visitor.

Constructor & Destructor Documentation

cppfs::FileVisitor::FileVisitor ( )

Constructor.

virtual cppfs::FileVisitor::~FileVisitor ( )
virtual

Destructor.

Member Function Documentation

virtual bool cppfs::FileVisitor::onFileEntry ( FileHandle fh)
protectedvirtual

Called on each file entry (files and directories)

Parameters
[in]fhHandle to file or directory
Remarks
The default implementation checks if the file handle points to a file or a directory and calls onFile() or onDirectory() respectively.
Returns
'true' if subdirectory should be traversed, else 'false'

Reimplemented in cppfs::FunctionalFileVisitor.

virtual bool cppfs::FileVisitor::onFile ( FileHandle fh)
protectedvirtual

Called on each file.

Parameters
[in]fhHandle to file
Returns
Irrelevant for files

Reimplemented in cppfs::FunctionalFileVisitor.

virtual bool cppfs::FileVisitor::onDirectory ( FileHandle fh)
protectedvirtual

Called on each directory.

Parameters
[in]fhHandle to directory
Returns
'true' if subdirectory should be traversed, else 'false'

Reimplemented in cppfs::FunctionalFileVisitor.

Friends And Related Function Documentation

friend class FileHandle
friend

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