名前空間
変種
操作

std::filesystem::directory_entry::status、std::filesystem::directory_entry::symlink_status

From cppreference.com
 
C++
コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ
 
ファイルシステムライブラリ
クラス
関数
ファイル種別
 
std::filesystem::directory_entry
メンバ関数
変更
監視
directory_entry::statusdirectory_entry::symlink_status
(C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20)
非メンバ関数
 
(1) (C++17以降)
std::filesystem::file_status status( std::error_code& ec ) const noexcept;
 (2) (C++17以降)
std::filesystem::file_status symlink_status() const;
 (3) (C++17以降)
std::filesystem::file_status symlink_status( std::error_code& ec ) const noexcept;
 (4) (C++17以降)
1,2) エントリのステータスを返します。これは、filesystem::status の呼び出しで決定される場合と同様です（シンボリックリンクはそのターゲットをたどります）。
3,4) エントリのステータスを返します。これは、filesystem::symlink_status の呼び出しで決定される場合と同様です（シンボリックリンクはたどりません）。

目次

[編集] パラメータ

エラーコード - 例外を投げないオーバーロードでのエラー報告のための出力パラメータ

[編集] 戻り値

エントリが指すファイルのステータス。

[編集] 例外

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

1,3) 基盤となるOS APIエラーが発生した場合、最初のパス引数として `p`、エラーコード引数としてOSのエラーコードを指定して `std::filesystem::filesystem_error` がスローされます。
2,4) OS API呼び出しが失敗した場合、OS APIのエラーコードを `std::error_code&` パラメータに設定し、エラーが発生しなかった場合は `ec.clear()` を実行します。

[編集] 注記

ディレクトリ走査のための多くの低レベルOS APIは、次のディレクトリエントリとともにファイル属性を取得します。 std::filesystem::directory_iterator のコンストラクタおよび非constメンバ関数は、これらの属性を、directory_entry::refresh を呼び出すことなく、ポイントされた std::filesystem::directory_entry に格納します。これにより、イテレート中にディレクトリエントリの属性を、追加のシステムコールなしで検査することが可能になります。

[編集] 例

このコードを実行
#include <cstdio>
#include <cstring>
#include <filesystem>
#include <fstream>
#include <iostream>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/un.h>
#include <unistd.h>
 
namespace fs = std::filesystem;
 
void demo_status(const fs::path& p, fs::file_status s)
{
    std::cout << p;
    // alternative: switch(s.type()) { case fs::file_type::regular: ...}
    if (fs::is_regular_file(s))
        std::cout << " is a regular file\n";
    if (fs::is_directory(s))
        std::cout << " is a directory\n";
    if (fs::is_block_file(s))
        std::cout << " is a block device\n";
    if (fs::is_character_file(s))
        std::cout << " is a character device\n";
    if (fs::is_fifo(s))
        std::cout << " is a named IPC pipe\n";
    if (fs::is_socket(s))
        std::cout << " is a named IPC socket\n";
    if (fs::is_symlink(s))
        std::cout << " is a symlink\n";
    if (!fs::exists(s))
        std::cout << " does not exist\n";
}
 
int main()
{
    // create files of different kinds
    fs::create_directory("sandbox");
    fs::create_directory("sandbox/dir");
    std::ofstream{"sandbox/file"}; // create regular file
    fs::create_symlink("file", "sandbox/symlink");
 
    mkfifo("sandbox/pipe", 0644);
    sockaddr_un addr;
    addr.sun_family = AF_UNIX;
    std::strcpy(addr.sun_path, "sandbox/sock");
    int fd = socket(PF_UNIX, SOCK_STREAM, 0);
    bind(fd, reinterpret_cast<sockaddr*>(&addr), sizeof addr);
 
    // demo different status accessors
    for (auto it{fs::directory_iterator("sandbox")}; it != fs::directory_iterator(); ++it)
        demo_status(*it, it->symlink_status()); // use cached status from directory entry
    demo_status("/dev/null", fs::status("/dev/null")); // direct calls to status
    demo_status("/dev/sda", fs::status("/dev/sda"));
    demo_status("sandbox/no", fs::status("/sandbox/no"));
 
    // cleanup (prefer std::unique_ptr-based custom deleters)
    close(fd);
    fs::remove_all("sandbox");
}

実行結果の例

"sandbox/file" is a regular file
"sandbox/dir" is a directory
"sandbox/pipe" is a named IPC pipe
"sandbox/sock" is a named IPC socket
"sandbox/symlink" is a symlink
"/dev/null" is a character device
"/dev/sda" is a block device
"sandbox/no" does not exist

[編集] 関連項目

 キャッシュされたファイル属性を更新します。
(public member function) [編集]
 ディレクトリエントリが既存のファイルシステムオブジェクトを参照しているかどうかを確認します
(public member function) [編集]
 ディレクトリエントリがブロックデバイスを参照しているかどうかをチェックします
(public member function) [編集]
 ディレクトリエントリがキャラクタデバイスを参照しているかどうかを確認します
(public member function) [編集]
 ディレクトリエントリーがディレクトリを参照しているかどうかをチェックします。
(public member function) [編集]
 ディレクトリエントリが名前付きパイプを参照しているかどうかをチェックします
(public member function) [編集]
 ディレクトリエントリが*その他の*ファイルを参照しているかどうかを確認します
(public member function) [編集]
 ディレクトリエントリが通常のファイルを参照するかどうかをチェックします
(public member function) [編集]
 ディレクトリエントリが名前付きIPCソケットを参照しているかどうかを確認します
(public member function) [編集]
 ディレクトリエントリがシンボリックリンクを参照しているかどうかをチェックします
(public member function) [編集]
 ディレクトリエントリが参照するファイルのサイズを返します。
(public member function) [編集]
 ディレクトリエントリが参照するファイルを参照するハードリンクの数を返します
(public member function) [編集]
 ディレクトリエントリが指すファイルの最終データ変更時刻を取得します。
(public member function) [編集]
"https://ja.cppreference.dev/mwiki/index.php?title=cpp/filesystem/directory_entry/status&oldid=158090" から取得
English 日本語 中文(简体) 中文(繁體)