std::filesystem::recursive_directory_iterator

class recursive_directory_iterator;

recursive_directory_iterator — это LegacyInputIterator, который выполняет итерацию по элементам directory_entry каталога и рекурсивно по записям всех подкаталогов. Порядок итерации не определён, за исключением того, что каждая запись каталога посещается только один раз.

По умолчанию символические ссылки не отслеживаются, но это можно включить, указав параметр каталога follow_directory_symlink при создании итератора.

Специальные имена путей точка и две точки пропускаются.

Если recursive_directory_iterator сообщает об ошибке или перемещается за последнюю запись каталога верхнего уровня, он становится равен итератору, созданному по умолчанию, также известному как конечный итератор. Два конечных итератора всегда равны; разыменование или инкремент конечного итератора приводит к неопределённому поведению.

Если файл или каталог удалён или добавлен в дерево каталогов после создания рекурсивного итератора каталога, не определено, будет ли это изменение видно через итератор.

Если структура каталогов содержит циклы, конечный итератор может быть недостижим.

Типы-члены

Функции-члены

Функции, не являющиеся членами

Кроме того, operator== и operator!= предоставляются(до C++20)operator== предоставляется(начиная с C++20) в соответствии с требованиями LegacyInputIterator.

Не определено, предоставляется ли operator!=, поскольку его можно синтезировать из operator==, а также(начиная с C++20) является ли оператор равенства функцией-членом или функцией, не являющейся членом.

Вспомогательные специализации

template<>
constexpr bool
    ranges::enable_borrowed_range<std::filesystem::recursive_directory_iterator> = true;

template<>
constexpr bool
    ranges::enable_view<std::filesystem::recursive_directory_iterator> = true;

Эти специализации для recursive_directory_iterator делают его borrowed_range и view.

Примечания

Объект recursive_directory_iterator обычно содержит указатель со счётчиком ссылок (для обеспечения семантики поверхностного копирования, требуемой LegacyInputIterator) на объект реализации, который содержит:

• контейнер (например, std::vector) нерекурсивных directory_iteratorов, образующих стек рекурсии;
• счётчик глубины рекурсии (доступен с помощью depth());
• параметры каталога, использованные при создании (доступны с помощью options());
• флаг ожидающей рекурсии (доступен с помощью recursion_pending(); может объединяться с параметрами каталога для экономии места).

Пример

#include <filesystem>
#include <fstream>
#include <iostream>
#include <string>
namespace fs = std::filesystem;

int main()
{
    std::filesystem::current_path(std::filesystem::temp_directory_path());
    std::filesystem::create_directories("sandbox/a/b");
    std::ofstream("sandbox/file1.txt");
    std::filesystem::create_symlink("a", "sandbox/syma");

    // Iterate over the std::filesystem::directory_entry elements explicitly
    auto entry_length{3UZ};
    for (const fs::directory_entry& dir_entry :
            fs::recursive_directory_iterator("sandbox"))
    {
        std::cout << dir_entry << '\n';
        if (auto l{dir_entry.path().string().length()}; entry_length < l)
            entry_length = l;
    }
    std::cout << std::string(entry_length + 2, '-') << '\n';

    // Iterate over the std::filesystem::directory_entry elements using `auto`
    for (auto const& dir_entry : fs::recursive_directory_iterator("sandbox"))
        std::cout << dir_entry << '\n';

    std::filesystem::remove_all("sandbox");
}

"sandbox/syma"
"sandbox/file1.txt"
"sandbox/a"
"sandbox/a/b"
-------------------
"sandbox/syma"
"sandbox/file1.txt"
"sandbox/a"
"sandbox/a/b"

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены задним числом к ранее опубликованным стандартам C++.

См. также