DirIter Class Reference
A class for iterating over all items in a directory. More...
#include <Filesystem.hh>
| Public Member Functions | |
| DirIter () | |
| Constructor for end element. | |
| DirIter (const std::string &_in) | |
| Constructor. | |
| bool | operator!= (const DirIter &_other) const | 
| Comparison operator to see if this iterator is at the same point as another iterator. | |
| std::string | operator* () const | 
| Dereference operator; returns current directory record. | |
| const DirIter & | operator++ () | 
| Pre-increment operator; moves to next directory record. | |
Detailed Description
A class for iterating over all items in a directory.
Constructor & Destructor Documentation
◆ DirIter() [1/2]
| DirIter | ( | ) | 
Constructor for end element.
◆ DirIter() [2/2]
| 
 | explicit | 
Constructor.
- Parameters
- 
  [in] _in Directory to iterate over. 
Member Function Documentation
◆ operator!=()
| bool operator!= | ( | const DirIter & | _other | ) | const | 
Comparison operator to see if this iterator is at the same point as another iterator.
- Parameters
- 
  [in] _other The other iterator to compare against. 
- Returns
- true if the iterators are equal, false otherwise.
◆ operator*()
| std::string operator* | ( | ) | const | 
Dereference operator; returns current directory record.
- Returns
- A string representing the entire path of the directory record.
◆ operator++()
| const DirIter & operator++ | ( | ) | 
Pre-increment operator; moves to next directory record.
- Returns
- This iterator.
The documentation for this class was generated from the following file: