文件系统库 (自 C++17 起)

 

C++

编译器支持

独立和宿主

语言

标准库

标准库头文件

命名需求

功能测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

文件系统库

类
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

 

文件系统库提供用于执行文件系统及其组件（如路径、常规文件和目录）操作的功能。

文件系统库最初被开发为 boost.filesystem，被发布为 技术规范 ISO/IEC TS 18822:2015，并最终在 C++17 中合并到 ISO C++ 中。boost 实现目前在比 C++17 库更多的编译器和平台上可用。

如果实现无法访问分层文件系统，或者它未提供必要的功能，则可能无法使用文件系统库功能。如果底层文件系统不支持某些功能（例如，FAT 文件系统缺少符号链接并禁止多个硬链接），则这些功能可能不可用。在这种情况下，必须报告错误。

如果对该库中函数的调用引入了 *文件系统竞争*，即当多个线程、进程或计算机交错访问和修改文件系统中的同一对象时，其行为是 未定义的。

库范围定义

• 文件：一个文件系统对象，它保存数据，可以写入、读取或两者兼而有之。文件有名称、属性，其中之一是文件类型

• 目录：一个充当目录项容器的文件，这些目录项标识其他文件（其中一些可能是其他嵌套目录）。在讨论特定文件时，它作为条目出现的目录是它的 *父目录*。父目录可以用相对路径名 ".." 表示。
• 常规文件：一个目录项，它将名称与现有文件（即 *硬链接*）相关联。如果支持多个硬链接，则在最后一个指向它的硬链接被删除后，文件将被删除。
• 符号链接：一个目录项，它将名称与路径相关联，该路径可能存在也可能不存在。
• 其他特殊文件类型：块、字符、fifo、套接字。

• 文件名：一个字符串，它命名一个文件。允许的字符、大小写敏感性、最大长度和不允许的名称由实现定义。名称 "."（点）和 ".."（点点）在库级别具有特殊含义。
• 路径：标识文件的元素序列。它以可选的 根名称（例如，Windows 上的 "C:" 或 "//server"）开头，后跟可选的 根目录（例如，Unix 上的 "/"），后跟零个或多个文件名序列（除了最后一个文件名以外，所有文件名必须是目录或指向目录的链接）。路径字符串表示形式（路径名）的本机格式（例如，哪些字符用作分隔符）和字符编码由实现定义，此库提供路径的可移植表示形式。

• 绝对路径：一个明确标识文件位置的路径。
• 规范路径：一个绝对路径，它不包含符号链接、"." 或 ".." 元素。
• 相对路径：一个标识文件位置相对于文件系统上某个位置的路径。特殊路径名 "."（点，“当前目录”）和 ".."（点点，“父目录”）是相对路径。

类
定义在头文件 <filesystem> 中
定义在命名空间 std::filesystem 中
path (C++17)	表示路径 (类)
filesystem_error (C++17)	在文件系统错误时抛出的异常 (类)
directory_entry (C++17)	一个目录项 (类)
directory_iterator (C++17)	指向目录内容的迭代器 (类)
recursive_directory_iterator (C++17)	指向目录及其子目录内容的迭代器 (类)
file_status (C++17)	表示文件类型和权限 (类)
space_info (C++17)	有关文件系统上的可用空间和可用空间的信息 (类)
file_type (C++17)	文件的类型 (枚举)
perms (C++17)	标识文件系统权限 (枚举)
perm_options (C++17)	指定权限操作的语义 (枚举)
copy_options (C++17)	指定复制操作的语义 (枚举)
directory_options (C++17)	用于迭代目录内容的选项 (枚举)
file_time_type (C++17)	表示文件时间值 (typedef)
非成员函数
定义在头文件 <filesystem> 中
定义在命名空间 std::filesystem 中
absolute (C++17)	组成一个绝对路径 (函数)
canonicalweakly_canonical (C++17)	组成一个规范路径 (函数)
relativeproximate (C++17)	组成一个相对路径 (函数)
copy (C++17)	复制文件或目录 (函数)
copy_file (C++17)	复制文件内容 (函数)
copy_symlink (C++17)	复制符号链接 (函数)
create_directorycreate_directories (C++17)(C++17)	创建新目录 (函数)
create_hard_link (C++17)	创建硬链接 (函数)
create_symlinkcreate_directory_symlink (C++17)(C++17)	创建符号链接 (函数)
current_path (C++17)	返回或设置当前工作目录 (函数)
exists (C++17)	检查路径是否引用现有文件系统对象 (函数)
equivalent (C++17)	检查两个路径是否引用同一个文件系统对象 (函数)
file_size (C++17)	返回文件的大小 (函数)
hard_link_count (C++17)	返回引用特定文件的硬链接数量 (函数)
last_write_time (C++17)	获取或设置最后数据修改时间 (函数)
permissions (C++17)	修改文件访问权限 (函数)
read_symlink (C++17)	获取符号链接的目标 (函数)
removeremove_all (C++17)(C++17)	删除文件或空目录 递归删除文件或目录及其所有内容 (函数)
rename (C++17)	移动或重命名文件或目录 (函数)
resize_file (C++17)	通过截断或零填充更改常规文件的大小 (函数)
space (C++17)	确定文件系统上的可用空闲空间 (函数)
statussymlink_status (C++17)(C++17)	确定文件属性 确定文件属性，检查符号链接目标 (函数)
temp_directory_path (C++17)	返回适合临时文件的目录 (函数)
文件类型
is_block_file (C++17)	检查给定路径是否引用块设备 (函数)
is_character_file (C++17)	检查给定路径是否引用字符设备 (函数)
is_directory (C++17)	检查给定路径是否引用目录 (函数)
is_empty (C++17)	检查给定路径是否引用空文件或目录 (函数)
is_fifo (C++17)	检查给定路径是否引用命名管道 (函数)
is_other (C++17)	检查参数是否引用其他文件 (函数)
is_regular_file (C++17)	检查参数是否引用常规文件 (函数)
is_socket (C++17)	检查参数是否引用命名 IPC 套接字 (函数)
is_symlink (C++17)	检查参数是否引用符号链接 (函数)
status_known (C++17)	检查文件状态是否已知 (函数)

注释

使用此库可能需要额外的编译器/链接器选项。9.1 之前的 GNU 实现需要链接 -lstdc++fs，而 9.0 之前的 LLVM 实现需要链接 -lc++fs。

功能测试 宏	值	Std	功能
__cpp_lib_filesystem	201703L	(C++17)	文件系统库

另请参阅

C++ 文档 for 文件系统 TS