cosmos::DirIterator Class Reference

This type implements range based for loop iterator semantics for DirStream. More...

#include <DirIterator.hxx>

Public Member Functions
	DirIterator (DirStream &dir, bool at_end)
bool	operator== (const DirIterator &other) const
bool	operator!= (const DirIterator &other) const
auto &	operator++ ()
DirEntry &	operator* ()

Protected Attributes
DirStream &	m_dir
std::optional< DirEntry >	m_entry

Detailed Description

This type implements range based for loop iterator semantics for DirStream.

This type and the related begin(DirStream&) and end(DirStream&) functions allow to use range based for loops with DirStream objects.

Definition at line 13 of file DirIterator.hxx.

Constructor & Destructor Documentation

DirIterator()

cosmos::DirIterator::DirIterator ( DirStream & dir, bool at_end )

inlineexplicit

Definition at line 16 of file DirIterator.hxx.

                                                          :
                        m_dir{dir} {
                if (!at_end)
                        m_entry = dir.nextEntry();
        }

Member Function Documentation

operator!=()

bool cosmos::DirIterator::operator!= ( const DirIterator & other ) const

inline

Definition at line 32 of file DirIterator.hxx.

                                                        {
                return !(*this == other);
        }

operator*()

DirEntry & cosmos::DirIterator::operator* ( )

inline

Definition at line 41 of file DirIterator.hxx.

                              {
                return *m_entry;
        }

operator++()

auto & cosmos::DirIterator::operator++ ( )

inline

Definition at line 36 of file DirIterator.hxx.

                           {
                m_entry = m_dir.nextEntry();
                return *this;
        }

operator==()

bool cosmos::DirIterator::operator== ( const DirIterator & other ) const

inline

Definition at line 22 of file DirIterator.hxx.

                                                        {
                if (m_entry.has_value() != other.m_entry.has_value())
                        return false;
                else if (!m_entry.has_value())
                        // both are at the end
                        return true;
 
                return m_entry->inode() == other.m_entry->inode();
        }

Member Data Documentation

m_dir

DirStream& cosmos::DirIterator::m_dir

protected

Definition at line 46 of file DirIterator.hxx.

m_entry

std::optional<DirEntry> cosmos::DirIterator::m_entry

protected

Definition at line 47 of file DirIterator.hxx.

---

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

• include/fs/DirIterator.hxx