std::filesystem::path

 

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

 

std::filesystem::path

常量
path::native_formatpath::generic_formatpath::auto_format
成员函数
path::path path::~path path::operator= path::assign path::appendpath::operator/= path::concatpath::operator+= path::clear path::make_preferred path::remove_filename path::replace_filename path::replace_extension      path::swap path::compare path::beginpath::end	path::c_strpath::nativepath::operator string_type path::stringpath::u8stringpath::u16stringpath::u32stringpath::wstring path::generic_stringpath::generic_u8stringpath::generic_u16stringpath::generic_u32stringpath::generic_wstring path::lexically_normalpath::lexically_relativepath::lexically_proximate
路径分解
path::root_name path::root_directory path::root_path path::relative_path path::parent_path path::filename path::stem path::extension path::empty	path::has_root_pathpath::has_root_namepath::has_root_directorypath::has_relative_pathpath::has_parent_pathpath::has_filenamepath::has_stempath::has_extension path::is_absolutepath::is_relative
非成员函数
operator==operator!=operator<operator<=operator>operator>=operator<=> (直到 C++20)(直到 C++20)(直到 C++20)(直到 C++20)(直到 C++20)(C++20)	operator/ operator<<operator>> swap(std::filesystem::path) hash_value u8path
辅助类
hash<std::filesystem::path>
formatter<std::filesystem::path> (C++26)

 

定义在头文件 <filesystem> 中
class path;		(自 C++17 起)

path 类型的对象表示文件系统上的路径。仅处理路径的语法方面：路径名可能表示不存在的路径，甚至可能表示在当前文件系统或操作系统上不允许存在的路径。

路径名具有以下语法

1. 根名称(可选): 标识具有多个根的文件系统上的根 (例如 "C:" 或 "//myserver")。如果存在歧义，则形成有效 根名称 的最长字符序列将被视为 根名称。标准库可能会定义除了操作系统 API 理解的根名称以外的附加根名称。
2. 根目录(可选): 一个目录分隔符，如果存在，则将此路径标记为绝对路径。如果缺少 (并且根名称以外的第一个元素是文件名)，则路径为相对路径，需要另一个路径作为起始位置才能解析为文件名。
3. 以下内容的零个或多个

• 文件名: 不包含目录分隔符或首选目录分隔符的字符序列 (操作系统或文件系统可能会施加其他限制)。此名称可能标识文件、硬链接、符号链接或目录。识别两个特殊的 文件名

• 点: 由单个点字符 . 组成的文件名是一个目录名称，它引用当前目录。
• 点点: 由两个点字符 .. 组成的文件名是一个目录名称，它引用父目录。

• 目录分隔符: 正斜杠字符 / 或作为 path::preferred_separator 提供的备用字符。如果此字符重复，则将其视为单个目录分隔符：/usr///////lib 与 /usr/lib 相同。

可以按照以下算法规范化路径

1. 如果路径为空，则停止 (空路径的规范形式是空路径)。
2. 将每个 目录分隔符 (可能由多个斜杠组成) 替换为单个 path::preferred_separator。
3. 将 根名称 中的每个斜杠字符替换为 path::preferred_separator。
4. 删除每个 点 和其后的任何 目录分隔符。
5. 删除每个紧随其后是 目录分隔符 和 点点 的非 点点 文件名，以及紧随其后的任何 目录分隔符。
6. 如果有 根目录，则删除所有 点点 以及紧随其后的任何 目录分隔符。
7. 如果最后一个文件名是 点点，则删除任何尾随的 目录分隔符。
8. 如果路径为空，则添加一个 点 (./ 的规范形式是 .)。

可以通过 begin() 和 end() 函数返回的迭代器逐个元素遍历路径，这些函数以通用格式查看路径并迭代根名称、根目录以及随后的文件名元素 (除标识根目录的目录分隔符外，其他目录分隔符将被跳过)。如果路径中的最后一个元素是目录分隔符，则最后一个迭代器将解除引用为空元素。

调用 path 的任何非 const 成员函数都会使所有引用该对象元素的迭代器失效。

如果操作系统使用与上面描述的便携式通用语法不同的本机语法，则定义为接受“检测到的格式”的库函数接受两种格式的路径名：当且仅当检测到的格式参数与通用格式匹配但操作系统无法接受为本机路径时，它被认为处于通用格式。在那些本机格式在目录路径名和文件路径名之间不同的操作系统上，如果通用路径名以目录分隔符结尾，则将其视为目录路径，否则将其视为常规文件。

无论如何，path 类都表现得好像它以本机格式存储路径名，并在需要时自动转换为通用格式 (每个成员函数都指定它将路径解释为哪种格式)。

在 POSIX 系统上，通用格式是本机格式，无需在两者之间进行区分或转换。

路径可以隐式转换为 std::basic_string，反之亦然，这使得可以使用其他文件 API。

流运算符 使用 std::quoted，以便空格在稍后由 流输入运算符 读取时不会导致截断。

分解成员函数 (例如 extension) 返回 filesystem::path 对象而不是字符串对象，就像其他 API 一样。

成员类型

类型	定义
value_type	文件系统原生编码使用的字符类型：在 POSIX 上为 char，在 Windows 上为 wchar_t
string_type	std::basic_string<value_type>
const_iterator	一个常量 LegacyInputIterator，其 value_type 为 path，满足 LegacyBidirectionalIterator 的所有要求，但对于两个相等的可以解引用的迭代器 a 和 b（类型为 const_iterator），*a 和 *b 不需要引用同一个对象。 const_iterator 是否实际上是一个 LegacyBidirectionalIterator 未指定。
iterator	const_iterator 的别名
format (C++17)	确定如何解释路径名的字符串表示形式。 还定义了以下枚举量 名称 解释 native_format 原生路径名格式 generic_format 通用路径名格式 auto_format 实现定义的格式，在可能的情况下自动检测 (公共成员枚举)

成员常量

constexpr value_type preferred_separator [静态]

除可移植的 / 之外，可能使用的备用目录分隔符。在 Windows 上，这是反斜杠字符 \。在 POSIX 上，这与可移植的分隔符相同，即正斜杠 / (公共静态成员常量)

成员函数

(构造函数)	构造 path (公共成员函数)
(析构函数)	销毁 path 对象 (公共成员函数)
operator=	赋值另一个路径 (公共成员函数)
assign	赋值内容 (公共成员函数)
串联
appendoperator/=	使用目录分隔符将元素追加到路径中 (公共成员函数)
concatoperator+=	串联两个路径，不引入目录分隔符 (公共成员函数)
修改器
clear	擦除内容 (公共成员函数)
make_preferred	将目录分隔符转换为首选目录分隔符 (公共成员函数)
remove_filename	删除文件名路径组件 (公共成员函数)
replace_filename	用另一个路径替换最后一个路径组件 (公共成员函数)
replace_extension	替换扩展名 (公共成员函数)
swap	交换两个路径 (公共成员函数)
格式观察器
c_strnativeoperator string_type	返回路径的原生版本 (公共成员函数)
stringwstringu8stringu16stringu32string	返回以原生路径名格式转换为字符串的路径 (公共成员函数)
generic_stringgeneric_wstringgeneric_u8stringgeneric_u16stringgeneric_u32string	返回以通用路径名格式转换为字符串的路径 (公共成员函数)
比较
compare	按字典序比较两个路径的词法表示形式 (公共成员函数)
生成
lexically_normallexically_relativelexically_proximate	将路径转换为规范形式 将路径转换为相对形式 将路径转换为邻近形式 (公共成员函数)
分解
root_name	返回路径的根名称（如果存在） (公共成员函数)
root_directory	返回路径的根目录（如果存在） (公共成员函数)
root_path	返回路径的根路径（如果存在） (公共成员函数)
relative_path	返回相对于根路径的路径 (公共成员函数)
parent_path	返回父路径的路径 (公共成员函数)
filename	返回文件名路径组件 (公共成员函数)
stem	返回词干路径组件（文件名不含最终扩展名） (公共成员函数)
extension	返回文件扩展名路径组件 (公共成员函数)
查询
empty	检查路径是否为空 (公共成员函数)
has_root_pathhas_root_namehas_root_directoryhas_relative_pathhas_parent_pathhas_filenamehas_stemhas_extension	检查相应的路径元素是否为空 (公共成员函数)
is_absoluteis_relative	检查 root_path() 是否唯一标识文件系统位置 (公共成员函数)
迭代器
beginend	以元素序列的形式访问路径的迭代器 (公共成员函数)

非成员函数

在 std::filesystem 命名空间中定义
swap(std::filesystem::path) (C++17)	专门化 std::swap 算法 (函数)
hash_value (C++17)	计算路径对象的哈希值 (函数)
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++17)(C++17)(直到 C++20)(C++17)(直到 C++20)(C++17)(直到 C++20)(C++17)(直到 C++20)(C++17)(直到 C++20)(C++20)	按字典序比较两个路径 (函数)
operator/ (C++17)	将两个路径与目录分隔符连接起来 (函数)
operator<<operator>> (C++17)	对带引号的路径执行流输入和输出 (函数)
u8path (C++17)(C++20 中已弃用)	从 UTF-8 编码的源创建 path (函数)

辅助类

在命名空间 std 中定义
std::hash<std::filesystem::path> (C++17)	对 std::filesystem::path 的哈希支持 (类模板特化)
std::formatter<std::filesystem::path> (C++26)	对 filesystem::path 的格式化支持 (类模板特化)

缺陷报告

以下行为更改缺陷报告已追溯应用于以前发布的 C++ 标准。

DR	应用于	已发布的行为	正确行为
LWG 3657	C++17	path 的 hash 被禁用	已启用