|
JUCE
|
Allows iterating over files and folders using C++11 range-for syntax. More...
#include <juce_RangedDirectoryIterator.h>
Public Types | |
| using | difference_type = std::ptrdiff_t |
| using | value_type = DirectoryEntry |
| using | reference = DirectoryEntry |
| using | pointer = void |
| using | iterator_category = std::input_iterator_tag |
Public Member Functions | |
| RangedDirectoryIterator ()=default | |
| The default-constructed iterator acts as the 'end' sentinel. | |
| RangedDirectoryIterator (const File &directory, bool isRecursive, const String &wildCard="*", int whatToLookFor=File::findFiles, File::FollowSymlinks followSymlinks=File::FollowSymlinks::yes) | |
| Creates a RangedDirectoryIterator for a given directory. | |
| bool | operator== (const RangedDirectoryIterator &other) const noexcept |
| Returns true if both iterators are in their end/sentinel state, otherwise returns false. | |
| bool | operator!= (const RangedDirectoryIterator &other) const noexcept |
| Returns the inverse of operator==. | |
| const DirectoryEntry & | operator* () const noexcept |
| Return an object containing metadata about the file or folder to which the iterator is currently pointing. | |
| const DirectoryEntry * | operator-> () const noexcept |
| RangedDirectoryIterator & | operator++ () |
| Moves the iterator along to the next file. | |
| DirectoryEntry | operator++ (int) |
| Moves the iterator along to the next file. | |
Allows iterating over files and folders using C++11 range-for syntax.
In the following example, we recursively find all hidden files in a specific directory.
| using RangedDirectoryIterator::difference_type = std::ptrdiff_t |
| using RangedDirectoryIterator::pointer = void |
| using RangedDirectoryIterator::iterator_category = std::input_iterator_tag |
|
default |
The default-constructed iterator acts as the 'end' sentinel.
| RangedDirectoryIterator::RangedDirectoryIterator | ( | const File & | directory, |
| bool | isRecursive, | ||
| const String & | wildCard = "*", | ||
| int | whatToLookFor = File::findFiles, | ||
| File::FollowSymlinks | followSymlinks = File::FollowSymlinks::yes ) |
Creates a RangedDirectoryIterator for a given directory.
The resulting iterator can be used directly in a 'range-for' expression.
| directory | the directory to search in |
| isRecursive | whether all the subdirectories should also be searched |
| wildCard | the file pattern to match. This may contain multiple patterns separated by a semi-colon or comma, e.g. "*.jpg;*.png" |
| whatToLookFor | a value from the File::TypesOfFileToFind enum, specifying whether to look for files, directories, or both. |
| followSymlinks | the policy to use when symlinks are encountered |
|
noexcept |
Returns true if both iterators are in their end/sentinel state, otherwise returns false.
Referenced by operator!=().
|
noexcept |
Returns the inverse of operator==.
References operator==().
|
noexcept |
Return an object containing metadata about the file or folder to which the iterator is currently pointing.
|
noexcept |
| RangedDirectoryIterator & RangedDirectoryIterator::operator++ | ( | ) |
Moves the iterator along to the next file.
| DirectoryEntry RangedDirectoryIterator::operator++ | ( | int | ) |
Moves the iterator along to the next file.