cppfs::FunctionalFileVisitor Class Reference

File visitor that calls a function. More...

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

Inheritance diagram for cppfs::FunctionalFileVisitor:

Collaboration diagram for cppfs::FunctionalFileVisitor:

Public Types
using	VisitFunc = std::function< bool(FileHandle &)>

Public Member Functions
	FunctionalFileVisitor ()
	Constructor. More...
	FunctionalFileVisitor (VisitFunc funcFileEntry)
	Constructor. More...
	FunctionalFileVisitor (VisitFunc funcFile, VisitFunc funcDirectory)
	Constructor. More...
virtual	~FunctionalFileVisitor ()
	Destructor. More...
Public Member Functions inherited from cppfs::FileVisitor
	FileVisitor ()
	Constructor. More...
virtual	~FileVisitor ()
	Destructor. More...

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

Protected Attributes
VisitFunc	m_funcFileEntry
VisitFunc	m_funcFile
VisitFunc	m_funcDirectory

Detailed Description

File visitor that calls a function.

Member Typedef Documentation

using cppfs::FunctionalFileVisitor::VisitFunc = std::function<bool(FileHandle &)>

Constructor & Destructor Documentation

cppfs::FunctionalFileVisitor::FunctionalFileVisitor

(

)

Constructor.

cppfs::FunctionalFileVisitor::FunctionalFileVisitor

(

VisitFunc

funcFileEntry

)

Constructor.

Parameters

[in]

funcFileEntry

Function that is call on each file entry (files and directories)

cppfs::FunctionalFileVisitor::FunctionalFileVisitor	(	VisitFunc	funcFile,
		VisitFunc	funcDirectory
	)

Constructor.

Parameters

[in]	funcFile	Function that is call on each file
[in]	funcDirectory	Function that is call on each directory

virtual cppfs::FunctionalFileVisitor::~FunctionalFileVisitor ( )

virtual

Destructor.

Member Function Documentation

virtual bool cppfs::FunctionalFileVisitor::onFileEntry ( FileHandle &  fh )

overrideprotectedvirtual

Called on each file entry (files and directories)

Parameters

[in]

fh

Handle 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 from cppfs::FileVisitor.

virtual bool cppfs::FunctionalFileVisitor::onFile ( FileHandle &  fh )

overrideprotectedvirtual

Called on each file.

Parameters

[in]

fh

Handle to file

Returns

Irrelevant for files

Reimplemented from cppfs::FileVisitor.

virtual bool cppfs::FunctionalFileVisitor::onDirectory ( FileHandle &  fh )

overrideprotectedvirtual

Called on each directory.

Parameters

[in]

fh

Handle to directory

Returns

'true' if subdirectory should be traversed, else 'false'

Reimplemented from cppfs::FileVisitor.

Member Data Documentation

VisitFunc cppfs::FunctionalFileVisitor::m_funcFileEntry

protected

VisitFunc cppfs::FunctionalFileVisitor::m_funcFile

protected

VisitFunc cppfs::FunctionalFileVisitor::m_funcDirectory

protected

---

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

• FunctionalFileVisitor.h