std::filesystem::equivalent

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

ファイルシステムライブラリ

クラス
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)	(C++17以降)
bool equivalent( const std::filesystem::path& p1,                  const std::filesystem::path& p2,                  std::error_code& ec ) noexcept;	(2)	(C++17以降)

パス p1 と p2 が同じファイルシステムエンティティを指すかどうかをチェックします。

p1 または p2 のいずれかが存在しない場合、エラーが報告されます。

例外を投げないオーバーロードは、エラー時に false を返します。

Parameters

p1, p2	-	等価性をチェックするパス
エラーコード	-	例外を投げないオーバーロードでのエラー報告のための出力パラメータ

Return value

true の場合、p1 と p2 が同じファイルまたはディレクトリを参照し、それらのファイルステータスが同じ場合。false の場合はそうでない。

Exceptions

noexcept とマークされていないオーバーロードは、メモリ割り当てが失敗した場合に std::bad_alloc をスローする可能性があります。

1) 下位 OS API エラーが発生した場合、std::filesystem::filesystem_error をスローします。この例外は、最初のパス引数として p1、2番目のパス引数として p2、エラーコード引数として OS エラーコードを指定して構築されます。

2) OS API呼び出しが失敗した場合、std::error_code& パラメータにOS APIのエラーコードが設定されます。エラーが発生しなかった場合は、ec.clear() が実行されます。

Notes

2つのパスが同じファイルシステムエンティティを指すと見なされるのは、パスが解決する2つの候補エンティティが同じデバイス上の同じ場所にある場合です。POSIX では、POSIX stat 構造体の st_dev および st_ino メンバーが等しいことを意味します。これは、POSIX stat() で取得された場合と同様です。

特に、同じファイルまたはディレクトリのすべてのハードリンクは同等であり、同じファイルシステム上のシンボリックリンクとそのターゲットは同等です。

Example

このコードを実行

#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"

Defect reports

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2937	C++17	エラー条件の指定が不正確	修正済み

See also

compare	2つのパスの字列表現を辞書順に比較します (public member function of std::filesystem::path)
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)	2つのパスを辞書順に比較します (function)
statussymlink_status (C++17)(C++17)	ファイルの属性を決定する シンボリックリンクのターゲットを確認してファイルの属性を決定する (関数)