cppfs::LocalFileIterator Class Reference

File iterator for the local file system. More...

#include <cppfs/include/cppfs/posix/LocalFileIterator.h>

Inheritance diagram for cppfs::LocalFileIterator:

Collaboration diagram for cppfs::LocalFileIterator:

Public Member Functions
	LocalFileIterator (std::shared_ptr< LocalFileSystem > fs, const std::string &path)
	Constructor. More...
	LocalFileIterator (std::shared_ptr< LocalFileSystem > fs, std::string &&path)
	Constructor. More...
virtual	~LocalFileIterator ()
	Destructor. More...
virtual std::unique_ptr< AbstractFileIteratorBackend >	clone () const override
	Create a copy of this iterator. More...
virtual AbstractFileSystem *	fs () const override
	Get file system. More...
virtual bool	valid () const override
	Check if iterator points to a valid item. More...
virtual std::string	path () const override
	Get path in file system on which the iterator operates. More...
virtual int	index () const override
	Get current index of iterator in the directory. More...
virtual std::string	name () const override
	Get name of current directory item. More...
virtual void	next () override
	Advance to the next item. More...
	LocalFileIterator (std::shared_ptr< LocalFileSystem > fs, const std::string &path)
	Constructor. More...
virtual	~LocalFileIterator ()
	Destructor. More...
virtual std::unique_ptr< AbstractFileIteratorBackend >	clone () const override
	Create a copy of this iterator. More...
virtual AbstractFileSystem *	fs () const override
	Get file system. More...
virtual bool	valid () const override
	Check if iterator points to a valid item. More...
virtual std::string	path () const override
	Get path in file system on which the iterator operates. More...
virtual int	index () const override
	Get current index of iterator in the directory. More...
virtual std::string	name () const override
	Get name of current directory item. More...
virtual void	next () override
	Advance to the next item. More...
Public Member Functions inherited from cppfs::AbstractFileIteratorBackend
	AbstractFileIteratorBackend ()
	Constructor. More...
virtual	~AbstractFileIteratorBackend ()
	Destructor. More...

Protected Member Functions
void	readNextEntry ()
void	readNextEntry ()

Protected Attributes
std::shared_ptr< LocalFileSystem >	m_fs
	File system that created this iterator. More...
std::string	m_path
	Path to file or directory. More...
DIR *	m_dir
	Directory handle. More...
struct dirent *	m_entry
	Current directory entry. More...
int	m_index
	Index of the current entry. More...
void *	m_findHandle
	Search handle. More...
void *	m_findData
	Information about the current file. More...

Detailed Description

File iterator for the local file system.

Constructor & Destructor Documentation

cppfs::LocalFileIterator::LocalFileIterator	(	std::shared_ptr< LocalFileSystem >	fs,
		const std::string &	path
	)

Constructor.

Parameters

[in]	fs	File system that created this iterator
[in]	path	Path to file or directory

cppfs::LocalFileIterator::LocalFileIterator	(	std::shared_ptr< LocalFileSystem >	fs,
		std::string &&	path
	)

Constructor.

Parameters

[in]	fs	File system that created this iterator
[in]	path	Path to file or directory

virtual cppfs::LocalFileIterator::~LocalFileIterator ( )

virtual

Destructor.

cppfs::LocalFileIterator::LocalFileIterator	(	std::shared_ptr< LocalFileSystem >	fs,
		const std::string &	path
	)

Constructor.

Parameters

[in]	fs	File system that created this iterator
[in]	path	Path to file or directory

virtual cppfs::LocalFileIterator::~LocalFileIterator ( )

virtual

Destructor.

Member Function Documentation

virtual std::unique_ptr<AbstractFileIteratorBackend> cppfs::LocalFileIterator::clone ( ) const

overridevirtual

Create a copy of this iterator.

Returns

File iterator

Implements cppfs::AbstractFileIteratorBackend.

virtual AbstractFileSystem* cppfs::LocalFileIterator::fs ( ) const

overridevirtual

Get file system.

Returns

File system (must NOT be null)

Implements cppfs::AbstractFileIteratorBackend.

virtual bool cppfs::LocalFileIterator::valid ( ) const

overridevirtual

Check if iterator points to a valid item.

Returns

'true' if valid, else 'false'

Implements cppfs::AbstractFileIteratorBackend.

virtual std::string cppfs::LocalFileIterator::path ( ) const

overridevirtual

Get path in file system on which the iterator operates.

Returns

Path

Implements cppfs::AbstractFileIteratorBackend.

virtual int cppfs::LocalFileIterator::index ( ) const

overridevirtual

Get current index of iterator in the directory.

Returns

Index, -1 if invalid

Implements cppfs::AbstractFileIteratorBackend.

virtual std::string cppfs::LocalFileIterator::name ( ) const

overridevirtual

Get name of current directory item.

Returns

File name

Implements cppfs::AbstractFileIteratorBackend.

virtual void cppfs::LocalFileIterator::next ( )

overridevirtual

Advance to the next item.

Implements cppfs::AbstractFileIteratorBackend.

void cppfs::LocalFileIterator::readNextEntry ( )

protected

virtual std::unique_ptr<AbstractFileIteratorBackend> cppfs::LocalFileIterator::clone ( ) const

overridevirtual

Create a copy of this iterator.

Returns

File iterator

Implements cppfs::AbstractFileIteratorBackend.

virtual AbstractFileSystem* cppfs::LocalFileIterator::fs ( ) const

overridevirtual

Get file system.

Returns

File system (must NOT be null)

Implements cppfs::AbstractFileIteratorBackend.

virtual bool cppfs::LocalFileIterator::valid ( ) const

overridevirtual

Check if iterator points to a valid item.

Returns

'true' if valid, else 'false'

Implements cppfs::AbstractFileIteratorBackend.

virtual std::string cppfs::LocalFileIterator::path ( ) const

overridevirtual

Get path in file system on which the iterator operates.

Returns

Path

Implements cppfs::AbstractFileIteratorBackend.

virtual int cppfs::LocalFileIterator::index ( ) const

overridevirtual

Get current index of iterator in the directory.

Returns

Index, -1 if invalid

Implements cppfs::AbstractFileIteratorBackend.

virtual std::string cppfs::LocalFileIterator::name ( ) const

overridevirtual

Get name of current directory item.

Returns

File name

Implements cppfs::AbstractFileIteratorBackend.

virtual void cppfs::LocalFileIterator::next ( )

overridevirtual

Advance to the next item.

Implements cppfs::AbstractFileIteratorBackend.

void cppfs::LocalFileIterator::readNextEntry ( )

protected

Member Data Documentation

std::shared_ptr< LocalFileSystem > cppfs::LocalFileIterator::m_fs

protected

File system that created this iterator.

std::string cppfs::LocalFileIterator::m_path

protected

Path to file or directory.

DIR* cppfs::LocalFileIterator::m_dir

protected

Directory handle.

struct dirent* cppfs::LocalFileIterator::m_entry

protected

Current directory entry.

int cppfs::LocalFileIterator::m_index

protected

Index of the current entry.

void* cppfs::LocalFileIterator::m_findHandle

protected

Search handle.

void* cppfs::LocalFileIterator::m_findData

protected

Information about the current file.

---

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

• posix/LocalFileIterator.h