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.

Detailed Description

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.

std::vector<File> hiddenFiles;
 
for (DirectoryEntry entry : RangedDirectoryIterator (File ("/path/to/folder"), isRecursive))
    if (entry.isHidden())
        hiddenFiles.push_back (entry.getFile());

@tags{Core}

Definition at line 99 of file juce_RangedDirectoryIterator.h.

Member Typedef Documentation

◆ difference_type

using juce::RangedDirectoryIterator::difference_type = std::ptrdiff_t

Definition at line 102 of file juce_RangedDirectoryIterator.h.

◆ iterator_category

using juce::RangedDirectoryIterator::iterator_category = std::input_iterator_tag

Definition at line 106 of file juce_RangedDirectoryIterator.h.

◆ pointer

using juce::RangedDirectoryIterator::pointer = void

Definition at line 105 of file juce_RangedDirectoryIterator.h.

◆ reference

using juce::RangedDirectoryIterator::reference = DirectoryEntry

Definition at line 104 of file juce_RangedDirectoryIterator.h.

◆ value_type

using juce::RangedDirectoryIterator::value_type = DirectoryEntry

Definition at line 103 of file juce_RangedDirectoryIterator.h.

Constructor & Destructor Documentation

◆ RangedDirectoryIterator()

juce::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.

Parameters

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