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

File iterator. More...

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

Public Member Functions

 FileIterator ()
 Constructor. More...
 
 FileIterator (std::unique_ptr< AbstractFileIteratorBackend > &&backend)
 Constructor. More...
 
 FileIterator (const FileIterator &fileIterator)
 Copy constructor. More...
 
 FileIterator (FileIterator &&fileIterator)
 Move constructor. More...
 
virtual ~FileIterator ()
 Destructor. More...
 
FileIteratoroperator= (const FileIterator &fileIterator)
 Copy operator. More...
 
std::string operator* () const
 Get name of current directory item. More...
 
void operator++ ()
 Advance to the next item. More...
 
bool operator== (const FileIterator &it) const
 Compare two iterators. More...
 
bool operator!= (const FileIterator &it) const
 Compare two iterators. More...
 

Protected Attributes

std::unique_ptr< AbstractFileIteratorBackendm_backend
 

Detailed Description

File iterator.

Constructor & Destructor Documentation

cppfs::FileIterator::FileIterator ( )

Constructor.

cppfs::FileIterator::FileIterator ( std::unique_ptr< AbstractFileIteratorBackend > &&  backend)

Constructor.

Parameters
[in]backendConcrete file handle backend
cppfs::FileIterator::FileIterator ( const FileIterator fileIterator)

Copy constructor.

Parameters
[in]fileHandleSource handle
cppfs::FileIterator::FileIterator ( FileIterator &&  fileIterator)

Move constructor.

Parameters
[in]fileHandleSource handle
virtual cppfs::FileIterator::~FileIterator ( )
virtual

Destructor.

Member Function Documentation

FileIterator& cppfs::FileIterator::operator= ( const FileIterator fileIterator)

Copy operator.

Parameters
[in]fileIteratorSource handle
std::string cppfs::FileIterator::operator* ( ) const

Get name of current directory item.

Returns
File name
void cppfs::FileIterator::operator++ ( )

Advance to the next item.

bool cppfs::FileIterator::operator== ( const FileIterator it) const

Compare two iterators.

Parameters
[in]itIterator
Returns
'true' if iterators are equal, else 'false'
bool cppfs::FileIterator::operator!= ( const FileIterator it) const

Compare two iterators.

Parameters
[in]itIterator
Returns
'true' if iterators are not equal, else 'false'

Member Data Documentation

std::unique_ptr<AbstractFileIteratorBackend> cppfs::FileIterator::m_backend
protected

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