std::filesystem::exists

 

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 exists( std::filesystem::file_status s ) noexcept;	(1)	(C++17以降)
bool exists( const std::filesystem::path& p );	(2)	(C++17以降)
bool exists( const std::filesystem::path& p, std::error_code& ec ) noexcept;	(3)	(C++17以降)

指定されたファイルステータスまたはパスが、存在するファイルまたはディレクトリに対応するかどうかを調べる。

1) status_known(s) && s.type() != file_type::not_found と等価。

2,3) s を、それぞれ status(p) または status(p, ec) (シンボリックリンクはたどられる) によって決定されるかのようにして得られる std::filesystem::file_status とする。そして exists(s) を返す。例外を投げないオーバーロードは、status_known(s) であれば ec.clear() を呼び出す。

引数

s	-	確認するファイルステータス
p	-	検査するパス
エラーコード	-	例外を投げないオーバーロードでのエラー報告のための出力パラメータ

戻り値

指定されたパスまたはファイルステータスが、存在するファイルまたはディレクトリに対応する場合は true、そうでなければ false。

例外

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

2) OSのAPIでエラーが発生した場合、std::filesystem::filesystem_error を投げる。このとき、最初のパス引数として p を、エラーコード引数としてOSのエラーコードを渡して構築される。

3) OSのAPI呼び出しが失敗した場合、std::error_code& 引数にOSのAPIエラーコードを設定し、エラーが発生しなかった場合は ec.clear() を実行する。

オブジェクトが存在しない場合、ファイルシステムの例外はスローされない (戻り値を使用すること)。

注釈

この関数によって提供される情報は、通常、ディレクトリのイテレーションの副産物としても提供される。ディレクトリのイテレーション中に exists(*iterator) を呼び出すことは、exists(iterator->status()) よりも効率が悪い。

例

このコードを実行

#include <cstdint>
#include <filesystem>
#include <fstream>
#include <iostream>
namespace fs = std::filesystem;
 
void demo_exists(const fs::path& p, fs::file_status s = fs::file_status{})
{
    std::cout << p;
    if (fs::status_known(s) ? fs::exists(s) : fs::exists(p))
        std::cout << " exists\n";
    else
        std::cout << " does not exist\n";
}
 
int main()
{
    const fs::path sandbox{"sandbox"};
    fs::create_directory(sandbox);
    std::ofstream{sandbox/"file"}; // create regular file
    fs::create_symlink("non-existing", sandbox/"symlink");
 
    demo_exists(sandbox);
 
    for (const auto& entry : fs::directory_iterator(sandbox))
        demo_exists(entry, entry.status()); // use cached status from directory entry
 
    fs::remove_all(sandbox);
}

出力

"sandbox" exists
"sandbox/symlink" does not exist
"sandbox/file" exists

関連項目

statussymlink_status (C++17)(C++17)	ファイルの属性を決定する シンボリックリンクのターゲットを確認してファイルの属性を決定する (関数)
file_status (C++17)	ファイルの種別とパーミッションを表現する (クラス)
exists	ディレクトリエントリが既存のファイルシステムオブジェクトを参照しているかどうかを確認します (std::filesystem::directory_entry の公開メンバ関数)