std::experimental::filesystem::recursive_directory_iterator

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名需求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

实验性

技术规范

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

库基础 (库基础 TS)

库基础 2 (库基础 TS v2)

库基础 3 (库基础 TS v3)

并行扩展 (并行 TS)

并行扩展 2 (并行 TS v2)

并发扩展 (并发 TS)

并发扩展 2 (并发 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;		(文件系统 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

成员函数

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

非成员函数

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

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

此外，operator== 和 operator!= 作为成员或非成员提供，如 LegacyInputIterator 所需。

注意

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

• 一个容器（如 std::vector）的非递归 directory_iterators，这些迭代器形成递归栈。
• 递归深度计数器（可以使用 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	目录内容的迭代器 (类)
directory_entry	目录项 (类)
directory_options	迭代目录内容的选项 (枚举)