std::filesystem::equivalent

 

C++

编译器支持

独立式和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (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::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
函数
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::temp_directory_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::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

 

定义于头文件 <filesystem>
bool equivalent( const std::filesystem::path& p1,                  const std::filesystem::path& p2 );	(1)	(since C++17)
bool equivalent( const std::filesystem::path& p1,                  const std::filesystem::path& p2,                  std::error_code& ec ) noexcept;	(2)	(since C++17)

检查路径 p1 和 p2 是否解析到相同的文件系统实体。

如果 p1 或 p2 之一不存在，则会报告错误。

非抛出重载在发生错误时返回 false。

参数

p1, p2	-	要检查是否等价的路径
ec	-	在非抛出重载中用于错误报告的输出参数

返回值

true 如果 p1 和 p2 指的是相同的文件或目录，并且它们的文件状态也相同。否则为 false。

异常

任何未标记为 noexcept 的重载都可能在内存分配失败时抛出 std::bad_alloc。

1) 当底层操作系统 API 发生错误时，抛出 std::filesystem::filesystem_error，并使用 p1 作为第一个路径参数，p2 作为第二个路径参数，以及操作系统错误代码作为错误代码参数来构造。

2) 如果操作系统 API 调用失败，则将 std::error_code& 参数设置为操作系统 API 错误代码；如果没有错误发生，则执行 ec.clear()。

注解

如果两个路径解析到的候选实体位于同一设备上的相同位置，则认为这两个路径解析到相同的文件系统实体。对于 POSIX，这意味着它们的 POSIX stat 结构的 st_dev 和 st_ino 成员（如同通过 POSIX stat() 获取）相等。

特别地，同一文件或目录的所有硬链接都是等价的，并且同一文件系统上的符号链接及其目标也是等价的。

示例

运行此代码

#include <cstdint>
#include <filesystem>
#include <iostream>
namespace fs = std::filesystem;
 
int main()
{
    // hard link equivalency
    fs::path p1 = ".";
    fs::path p2 = fs::current_path();
    if (fs::equivalent(p1, p2))
        std::cout << p1 << " is equivalent to " << p2 << '\n';
 
    // symlink equivalency
    for (const fs::path lib : {"/lib/libc.so.6", "/lib/x86_64-linux-gnu/libc.so.6"})
    {
        try
        {
            p2 = lib.parent_path() / fs::read_symlink(lib);
        }
        catch (std::filesystem::filesystem_error const& ex)
        {
            std::cout << ex.what() << '\n';
            continue;
        }
 
        if (fs::equivalent(lib, p2))
            std::cout << lib << " is equivalent to " << p2 << '\n';
    }
}

可能的输出

"." is equivalent to "/var/tmp/test"
filesystem error: read_symlink: No such file or directory [/lib/libc.so.6]
"/lib/x86_64-linux-gnu/libc.so.6" is equivalent to "/lib/x86_64-linux-gnu/libc-2.23.so"

缺陷报告

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

DR	应用于	已发布行为	正确行为
LWG 2937	C++17	错误条件指定不正确	已更正

参见

compare	按字典顺序比较两个路径的词法表示 (std::filesystem::path 的公共成员函数)
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++17)(C++17)(until C++20)(C++17)(until C++20)(C++17)(until C++20)(C++17)(until C++20)(C++17)(until C++20)(C++20)	按字典顺序比较两个路径 (函数)
statussymlink_status (C++17)(C++17)	确定文件属性 确定文件属性，检查符号链接目标 (函数)