std::filesystem::directory_iterator

来自cppreference.com
 
C++
 
文件系统库
类
函数
文件类型
 
std::filesystem::directory_iterator
 
<tbody> </tbody>
在标头 <filesystem> 定义
class directory_iterator;
 (C++17 起)
See More

directory_iterator 是一种在目录的 directory_entry 元素上迭代的老式输入迭代器 (LegacyInputIterator) （但不造访子目录）。迭代顺序是未指定的，但每个目录条目只被造访一次。跳过特殊路径名 点 和 点点。

若前移 directory_iterator 越过了最终目录条目，则它变为等于默认构造的迭代器，亦称为尾迭代器。两个尾迭代器始终相等，解引用或自增尾迭代器是未定义行为。

若在创建目录迭代器之后将文件或目录删除或添加到目录树，则是否会通过迭代器观察到更改是未指定的。

成员类型

成员类型 定义
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

成员函数

 构造 directory_iterator
(公开成员函数) [编辑]
(析构函数)
 默认析构函数
(公开成员函数) [编辑]
对内容赋值
(公开成员函数) [编辑]
访问所指的目录条目
(公开成员函数) [编辑]
前进到下个目录条目
(公开成员函数) [编辑]

非成员函数

 基于范围的 for 循环支持
(函数) [编辑]

另外按老式输入迭代器 (LegacyInputIterator) 所要求提供 operator== 和 operator!=(C++20 前)operator==(C++20 起)。

是否提供 operator!=（因为它能从 operator== 合成），以及(C++20 起)相等运算符是成员还是非成员是未指定的。

辅助特化

<tbody> </tbody>
template<> constexpr bool ranges::enable_borrowed_range<std::filesystem::directory_iterator> = true;
 (C++20 起)
template<> constexpr bool ranges::enable_view<std::filesystem::directory_iterator> = true;
 (C++20 起)

这些对 directory_iterator 的特化使之为 borrowed_range 及 view。

注解

许多遍历目录的低层 OS API 将下个目录条目与文件属性一同获取。若它们存在，则 std::filesystem::directory_iterator 的构造函数和非 const 成员函数将这些属性存储于所指向的 std::filesystem::directory_entry 中，而不调用 directory_entry::refresh。这使得程序能够在迭代目录条目的同时检验其属性，而不进行额外的系统调用。

示例

运行此代码
#include <algorithm>
#include <filesystem>
#include <fstream>
#include <iostream>

int main()
{
    const std::filesystem::path sandbox{"sandbox"};
    std::filesystem::create_directories(sandbox/"dir1"/"dir2");
    std::ofstream{sandbox/"file1.txt"};
    std::ofstream{sandbox/"file2.txt"};
 
    std::cout << "directory_iterator:\n";
    // 可以使用范围 for 循环来迭代 directory_iterator
    for (auto const& dir_entry : std::filesystem::directory_iterator{sandbox}) 
        std::cout << dir_entry.path() << '\n';

    std::cout << "\ndirectory_iterator 作为范围:\n";
    // directory_iterator 也以其他方式表现为范围
    std::ranges::for_each(
        std::filesystem::directory_iterator{sandbox},
        [](const auto& dir_entry) { std::cout << dir_entry << '\n'; });

    std::cout << "\nrecursive_directory_iterator:\n";
    for (auto const& dir_entry : std::filesystem::recursive_directory_iterator{sandbox}) 
        std::cout << dir_entry << '\n';
 
    // 删除 sandbox 目录和其所有内容，包括子目录
    std::filesystem::remove_all(sandbox);
}

可能的输出： 

directory_iterator:
"sandbox/file2.txt"
"sandbox/file1.txt"
"sandbox/dir1"

directory_iterator 作为范围:
"sandbox/file2.txt"
"sandbox/file1.txt"
"sandbox/dir1"

recursive_directory_iterator:
"sandbox/file2.txt"
"sandbox/file1.txt"
"sandbox/dir1"
"sandbox/dir1/dir2"

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 3480 C++20 directory_iterator 既非 borrowed_range 亦非 view 它都是

参阅

(C++17)
 指向一个目录及其子目录的内容的迭代器
(类) [编辑]
(C++17)
 用于迭代目录内容的选项
(枚举) [编辑]
(C++17)
 目录条目
(类) [编辑]