std::experimental::filesystem::recursive_directory_iterator

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

实验性

技术规范

文件系统库 (文件系统 TS)

库基础 (库基础 TS)

库基础 2 (库基础 TS v2)

库基础 3 (库基础 TS v3)

并行性扩展 (并行性 TS)

并行性扩展 2 (并行性 TS v2)

并发性扩展 (并发性 TS)

并发扩展 2 (concurrency TS v2)

概念 (概念 TS)

范围 (范围 TS)

反射 (反射 TS)

数学特殊函数 (特殊函数 TR)

实验性非 TS

模式匹配

线性代数

std::execution

契约

2D 图形

 

文件系统库

类
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator filesystem::file_status	filesystem::space_info filesystem::file_type filesystem::perms filesystem::copy_options filesystem::directory_options filesystem::file_time_type
函数
filesystem::absolute filesystem::system_complete filesystem::canonical filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path filesystem::exists filesystem::equivalent	filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status filesystem::temp_directory_path
文件类型
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

 

recursive_directory_iterator

成员函数

recursive_directory_iterator::recursive_directory_iterator

recursive_directory_iterator::operator*recursive_directory_iterator::operator->

recursive_directory_iterator::options

recursive_directory_iterator::depth

recursive_directory_iterator::recursion_pending

recursive_directory_iterator::operator=

recursive_directory_iterator::incrementrecursive_directory_iterator::operator++

recursive_directory_iterator::pop

recursive_directory_iterator::disable_recursion_pending

非成员函数

begin(recursive_directory_iterator)end(recursive_directory_iterator)

 

定义于头文件 <experimental/filesystem>
class recursive_directory_iterator;		(filesystem TS)

recursive_directory_iterator 是一个 LegacyInputIterator，它迭代目录的 directory_entry 元素，并递归迭代所有子目录的条目。迭代顺序未指定，除了每个目录条目只访问一次。

默认情况下，不跟随符号链接，但这可以通过在构造时指定目录选项 follow_directory_symlink 来启用。

特殊路径名 dot 和 dot-dot 会被跳过。

如果 recursive_directory_iterator 超越顶层目录的最后一个目录条目，它将变得与默认构造的迭代器（也称为结束迭代器）相等。两个结束迭代器总是相等，解引用或递增结束迭代器是未定义行为。

如果在创建递归目录迭代器后，文件或目录被删除或添加到目录树中，则通过迭代器是否观察到此更改是未指定的。

如果目录结构包含循环，则可能无法到达结束迭代器。

成员类型

成员类型	定义
value_type	filesystem::directory_entry
difference_type	std::ptrdiff_t
pointer	const filesystem::directory_entry*
reference	const filesystem::directory_entry&
iterator_category	std::input_iterator_tag

成员函数

(构造函数)	构造一个递归目录迭代器 (public member function)
(析构函数)	默认析构函数 (public member function)
观察器
operator*operator->	访问指向的条目 (public member function)
options	返回当前活跃的影响迭代的选项 (public member function)
depth	返回当前递归深度 (public member function)
recursion_pending	检查当前目录是否禁用递归 (public member function)
修改器
operator=	赋值内容 (public member function)
incrementoperator++	前进到下一个条目 (public member function)
pop	在目录层次结构中将迭代器向上移动一级 (public member function)
disable_recursion_pending	禁用递归直到下一次递增 (public member function)

非成员函数

filesystem::begin(filesystem::recursive_directory_iterator)filesystem::end(filesystem::recursive_directory_iterator)

支持基于范围的 for 循环 (function)

此外，根据 LegacyInputIterator 的要求，提供了 operator== 和 operator!=，作为成员函数或非成员函数。

注意

recursive_directory_iterator 通常持有一个引用计数的指针（以满足 LegacyInputIterator 的浅拷贝语义）到一个实现对象，该对象持有

• 一个非递归 directory_iterators 的容器（例如 std::vector），它构成了递归栈。
• 递归深度计数器（可通过 depth() 访问）。
• 构造时使用的目录选项（可通过 options() 访问）。
• 待定递归标志（可通过 recursion_pending() 访问，可与目录选项结合以节省空间）。

示例

运行此代码

#include <experimental/filesystem>
#include <fstream>
#include <iostream>
namespace fs = std::experimental::filesystem;
 
int main()
{
    fs::create_directories("sandbox/a/b");
    std::ofstream("sandbox/file1.txt");
    fs::create_symlink("a", "sandbox/syma");
    for (const fs::directory_entry& entry : fs::recursive_directory_iterator("sandbox"))
        std::cout << entry << '\n';
    fs::remove_all("sandbox");
}

可能的输出

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

另请参见

directory_iterator	指向目录内容的迭代器 (class)
directory_entry	目录项 (class)
directory_options	迭代目录内容的选项 (enum)