Defined in header <filesystem> | ||
|---|---|---|
class recursive_directory_iterator; | (since C++17) |
recursive_directory_iterator is an LegacyInputIterator that iterates over the directory_entry elements of a directory, and, recursively, over the entries of all subdirectories. The iteration order is unspecified, except that each directory entry is visited only once.
By default, symlinks are not followed, but this can be enabled by specifying the directory option follow_directory_symlink at construction time.
The special pathnames dot and dot-dot are skipped.
If the recursive_directory_iterator reports an error or is advanced past the last directory entry of the top-level directory, it becomes equal to the default-constructed iterator, also known as the end iterator. Two end iterators are always equal, dereferencing or incrementing the end iterator is undefined behavior.
If a file or a directory is deleted or added to the directory tree after the recursive directory iterator has been created, it is unspecified whether the change would be observed through the iterator.
If the directory structure contains cycles, the end iterator may be unreachable.
| Member type | Definition |
|---|---|
value_type | std::filesystem::directory_entry |
difference_type | std::ptrdiff_t |
pointer | const std::filesystem::directory_entry* |
reference | const std::filesystem::directory_entry& |
iterator_category | std::input_iterator_tag |
| constructs a recursive directory iterator (public member function) |
|
| (destructor) | default destructor (public member function) |
Observers |
|
| accesses the pointed-to entry (public member function) |
|
| returns the currently active options that affect the iteration (public member function) |
|
| returns the current recursion depth (public member function) |
|
| checks whether the recursion is disabled for the current directory (public member function) |
|
Modifiers |
|
| assigns contents (public member function) |
|
| advances to the next entry (public member function) |
|
| moves the iterator one level up in the directory hierarchy (public member function) |
|
| disables recursion until the next increment (public member function) |
|
| range-based for loop support (function) |
Additionally, operator== and operator!= are provided, either as members or as non-members, as required by LegacyInputIterator.
A recursive_directory_iterator typically holds a reference-counted pointer (to satisfy shallow-copy semantics of LegacyInputIterator) to an implementation object, which holds:
std::vector) of non-recursive directory_iterators that forms the recursion stack depth()) options()) recursion_pending(), may be combined with the directory options to save space) #include <fstream>
#include <iostream>
#include <filesystem>
namespace fs = std::filesystem;
int main()
{
fs::create_directories("sandbox/a/b");
std::ofstream("sandbox/file1.txt");
fs::create_symlink("a", "sandbox/syma");
for(auto& p: fs::recursive_directory_iterator("sandbox"))
std::cout << p.path() << '\n';
fs::remove_all("sandbox");
}Possible output:
"sandbox/a" "sandbox/a/b" "sandbox/file1.txt" "sandbox/syma"
|
(C++17) | an iterator to the contents of the directory (class) |
|
(C++17) | a directory entry (class) |
|
(C++17) | options for iterating directory contents (enum) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://en.cppreference.com/w/cpp/filesystem/recursive_directory_iterator