std::filesystem::directory_iterator

 

C++

语言

标准库头文件

概念

工具库

字符串库

容器库

算法库

迭代器库

数值库

输入/输出库

本地化库

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

原子操作库 (C++11)

线程支持库 (C++11)

文件系统库 (C++17)

技术规范

 

文件系统库

类
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::perm_options filesystem::copy_options filesystem::directory_options filesystem::file_time_type
函数
filesystem::absolute filesystem::canonicalfilesystem::weakly_canonical filesystem::relativefilesystem::proximate 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

 

std::filesystem::directory_iterator

成员函数

directory_iterator::directory_iterator

directory_iterator::operator*directory_iterator::operator->

directory_iterator::operator=

incrementoperator++

非成员函数

begin(std::filesystem::directory_iterator)end(std::filesystem::directory_iterator)

 

定义于头文件 <filesystem>
class directory_iterator;		(C++17 起)

directory_iterator 是一个迭代于目录的 directory_entry 元素上的输入迭代器 (InputIterator) （但不造访子目录）。迭代顺序是未指定的，除了每个目录入口只被造访一次。跳过特殊路径名 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 (公开成员函数)
(析构函数)	默认析构函数 (公开成员函数)
operator=	对内容赋值 (公开成员函数)
operator* operator->	访问所指的入口 (公开成员函数)
increment operator++	前进到下个入口 (公开成员函数)

非成员函数

begin(std::filesystem::directory_iterator) end(std::filesystem::directory_iterator)

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

另外，提供 operator== 和 operator!= 为成员或非成员函数，如输入迭代器 (InputIterator) 所要求。

注意

许多遍历目录的低层 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 << '\n';
    fs::remove_all("sandbox");
}

可能的输出：

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

参阅

recursive_directory_iterator (C++17)	指向一个目录及其子目录内容的迭代器 (类)
directory_options (C++17)	迭代目录内容的选项 (枚举)
directory_entry (C++17)	目录入口 (类)