std::filesystem::directory_iterator

 
C++
 
文件系统库
类
函数
文件类型
 
std::filesystem::directory_iterator
 
定义于头文件 <filesystem>
class directory_iterator;
 (C++17 起)

directory_iterator 是一个迭代于目录的 directory_entry 元素上的遗留输入迭代器 (LegacyInputIterator) （但不造访子目录）。迭代顺序是未指定的，除了每个目录条目只被造访一次。跳过特殊路径名 dot 和 dot-dot 。

若前移 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!= 为成员或非成员函数。

注意

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

示例

运行此代码
#include <fstream>
#include <iostream>
#include <filesystem>
namespace fs = std::filesystem;
 
int main()
{
    fs::create_directories("sandbox/a/b");
    std::ofstream("sandbox/file1.txt");
    std::ofstream("sandbox/file2.txt");
    for(auto& p: fs::directory_iterator("sandbox"))
        std::cout << p.path() << '\n';
    fs::remove_all("sandbox");
}

可能的输出： 

"sandbox/a"
"sandbox/file1.txt"
"sandbox/file2.txt"

参阅

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