Namespaces
Variants

std::filesystem:: status, std::filesystem:: symlink_status

From cppreference.net
C++
Filesystem library
Classes
Functions
File types
ヘッダーで定義 <filesystem>
(1) (C++17以降)
(2) (C++17以降)
(3) (C++17以降)
(4) (C++17以降)
1,2) POSIXの stat と同様に（シンボリックリンクはターゲット先に解決される）、 p で識別されるファイルシステムオブジェクトの型と属性を決定する。以下の説明において、 prms は ( m & perms :: mask ) の結果であり、ここで m はPOSIXの struct stat から st_mode を取得し、それを型 std:: filesystem :: perms に変換したものとして得られる。
  • p が通常ファイル（POSIXの S_ISREG による判定と同様）の場合、 file_status ( file_type :: regular , prms ) を返す。
  • p がディレクトリ（POSIXの S_ISDIR による判定と同様）の場合、 file_status ( file_type :: directory , prms ) を返す。
  • p がブロック特殊ファイル（POSIXの S_ISBLK による判定と同様）の場合、 file_status ( file_type :: block , prms ) を返す。
  • p がキャラクタ特殊ファイル（POSIXの S_ISCHR による判定と同様）の場合、 file_status ( file_type :: character , prms ) を返す。
  • p がFIFOまたはパイプファイル（POSIXの S_ISFIFO による判定と同様）の場合、 file_status ( file_type :: fifo , prms ) を返す。
  • p がソケット（POSIXの S_ISSOCK による判定と同様）の場合、 file_status ( file_type :: socket , prms ) を返す。
  • p が実装定義のファイル型を持つ場合、 file_status ( file_type :: A , prms ) を返す。ここで A はその型に対する実装定義の file_type 定数である。
  • p が存在しない場合、 file_status ( file_type :: not_found ) を返す。
  • p が存在するが、権限不足などの理由でファイル属性を決定できない場合、 file_status ( file_type :: unknown ) を返す。
  • エラーにより p の存在すら確認できない場合、非スローオーバーロードは ec を設定して file_status ( file_type :: none ) を返し、スローオーバーロードは filesystem_error をスローする。
  • それ以外の場合、 file_status ( file_type :: unknown , prms ) を返す。
3,4) 以下は (1,2) と同じですが、POSIXの lstat が使用された場合と同様の動作をします（シンボリックリンクは追従されません）：
  • p がシンボリックリンクの場合、 file_status ( file_type :: symlink ) を返します。

目次

パラメータ

p - 検査対象のパス
ec - 例外を投げないオーバーロードにおけるエラー報告用出力パラメータ

戻り値

ファイルステータス（ filesystem::file_status オブジェクト）。

例外

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

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

注記

この関数によって提供される情報は通常、ディレクトリ走査の副産物としても提供され、 filesystem::directory_entry のメンバ関数によって取得することができます。ディレクトリ走査中に status を再度呼び出す必要はありません。

例

このコードを実行 
#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;
    // 代替案: 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()
{
    // 異なる種類のファイルを作成
    fs::create_directory("sandbox");
    fs::create_directory("sandbox/dir");
    std::ofstream{"sandbox/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);
    // 異なるステータスアクセサのデモ
    for (auto it{fs::directory_iterator("sandbox")}; it != fs::directory_iterator(); ++it)
        demo_status(*it, it->symlink_status()); // ディレクトリエントリからキャッシュされたステータスを使用
    demo_status("/dev/null", fs::status("/dev/null")); // statusへの直接呼び出し
    demo_status("/dev/sda", fs::status("/dev/sda"));
    demo_status("sandbox/no", fs::status("/sandbox/no"));
    // クリーンアップ（std::unique_ptrベースのカスタム削除機能を推奨）
    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

関連項目

(C++17)
ファイルの種類とパーミッションを表す
(クラス)
(C++17)
ファイルステータスが既知かどうかをチェックする
(関数)
(C++17)
指定されたパスがブロックデバイスを参照するかチェックする
(関数)
(C++17)
指定されたパスがキャラクターデバイスを参照するかチェックする
(関数)
(C++17)
指定されたパスがディレクトリを参照するかチェックする
(関数)
(C++17)
指定されたパスが名前付きパイプを参照するかチェックする
(関数)
(C++17)
引数が その他 のファイルを参照するかチェックする
(関数)
(C++17)
引数が通常ファイルを参照するかチェックする
(関数)
(C++17)
引数が名前付きIPCソケットを参照するかチェックする
(関数)
(C++17)
引数がシンボリックリンクを参照するかチェックする
(関数)
(C++17)
パスが既存のファイルシステムオブジェクトを参照するかチェックする
(関数)
このディレクトリエントリによって指定されるファイルのステータス;
このディレクトリエントリによって指定されるファイル/シンボリックリンクのステータス
( std::filesystem::directory_entry の公開メンバ関数)