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

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

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

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

技術仕様書

 

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

クラス
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::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options filesystem::file_time_type
関数
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::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::temp_directory_path
ファイル種別
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

 

<tbody> </tbody>

ヘッダ <filesystem> で定義
std::filesystem::file_status status(const std::filesystem::path& p); std::filesystem::file_status status(const std::filesystem::path& p, std::error_code& ec) noexcept;	(1)	(C++17以上)
std::filesystem::file_status symlink_status(const std::filesystem::path& p); std::filesystem::file_status symlink_status(const std::filesystem::path& p, std::error_code& ec) noexcept;	(2)	(C++17以上)

1) 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) を返します。

2) (1) と同じですが、 POSIX の lstat (シンボリックを辿りません) が使用されたかのように動作します。

• p がシンボリックリンクの場合は、 file_status(file_type::symlink) を返します。

引数

p	-	調べるパス
ec	-	例外を投げないオーバーロードでエラーを報告するための出力引数

戻り値

ファイルステータス (file_status オブジェクト)。

例外

std::error_code& 引数を取らないオーバーロードは、ベースとなる OS の API でエラーが発生した場合、第1パス引数に p、エラーコード引数に OS のエラーコードを指定して構築された filesystem_error を投げます。 std::error_code& 引数を取るオーバーロードは、 OS の API 呼び出しが失敗した場合、その引数を OS の API のエラーコードに設定し、エラーが発生しない場合は ec.clear() を実行します。 noexcept 指定のないあらゆるオーバーロードは、メモリ確保に失敗した場合 std::bad_alloc を投げる可能性があります。

ノート

この関数によって提供される情報は、通常、ディレクトリイテレーションの副産物としても提供され、 directory_entry のメンバ関数によって取得できます。 ディレクトリイテレーション中は、 status の再度の呼び出しは不要です。

例

Run this code

#include <iostream>
#include <fstream>
#include <cstdio>
#include <cstring>
#include <filesystem>
#include <unistd.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <sys/stat.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");
    std::ofstream("sandbox/file"); // create regular file
    fs::create_directory("sandbox/dir");
    mkfifo("sandbox/pipe", 0644);
    struct 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, (struct sockaddr*)&addr, sizeof addr);
    fs::create_symlink("file", "sandbox/symlink");

    // 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
    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

関連項目

file_status (C++17)	ファイル種別とパーミッションを表します (クラス)
status_known (C++17)	ファイルの状態が判明しているかどうか調べます (関数)
is_block_file (C++17)	指定されたパスがブロックデバイスを参照しているかどうか調べます (関数)
is_character_file (C++17)	指定されたパスがキャラクタデバイスを参照しているかどうか調べます (関数)
is_directory (C++17)	指定されたパスがディレクトリを参照しているかどうか調べます (関数)
is_fifo (C++17)	指定されたパスが名前付きパイプを参照しているかどうか調べます (関数)
is_other (C++17)	指定されたパスがその他のファイルを参照しているかどうか調べます (関数)
is_regular_file (C++17)	指定されたパスが普通のファイルを参照しているかどうか調べます (関数)
is_socket (C++17)	指定されたパスが名前付き IPC ソケットを参照しているかどうか調べます (関数)
is_symlink (C++17)	指定されたパスがシンボリックリンクを参照しているかどうか調べます (関数)
exists (C++17)	パスが既存のファイルシステムオブジェクトを参照しているかどうか調べます (関数)
statussymlink_status	ディレクトリエントリが参照しているファイルのステータス ディレクトリエントリが参照しているファイルのシンボリックリンクステータス (std::filesystem::directory_entryのパブリックメンバ関数)