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

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

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

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

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

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

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

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

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

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

実験的

Technical Specification

ファイルシステムライブラリ (filesystem TS)

ライブラリ基本 (library fundamentals TS)

ライブラリ基本TS v2 (library fundamentals TS v2)

ライブラリ基本 3 (library fundamentals TS v3)

並列化拡張 (parallelism TS)

並列化拡張 2 (parallelism TS v2)

並行処理拡張 (concurrency TS)

並行処理拡張 2 (concurrency TS v2)

コンセプト (concepts TS)

Ranges (ranges TS)

リフレクション (reflection TS)

数学特殊関数 (special functions TR)

実験的 (非TS)

パターンマッチ

線形代数

std::execution

契約プログラミング

2Dグラフィックス

 

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

クラス
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::copy_options filesystem::directory_options filesystem::file_time_type
関数
filesystem::absolute filesystem::system_complete filesystem::canonical 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

 

ヘッダー <experimental/filesystem> で定義されています
file_status status( const path& p ); file_status status( const path& p, error_code& ec ) noexcept;	(1)	(filesystem TS)
file_status symlink_status( const path& p ); file_status symlink_status( const path& p, error_code& ec ) noexcept;	(2)	(filesystem TS)

1) POSIX の stat を呼び出すかのように、p が識別するファイルシステムオブジェクトのタイプと属性を決定します (シンボリックリンクはターゲットをたどります)。

• もし p が通常のファイルであれば、file_status(file_type::regular) を返します。
• もし p がディレクトリであれば、file_status(file_type::directory) を返します。
• もし p がブロック特殊ファイルであれば、file_status(file_type::block) を返します。
• もし p が文字特殊ファイルであれば、file_status(file_type::character) を返します。
• もし p が FIFO またはパイプファイルであれば、file_status(file_type::fifo) を返します。
• もし p がソケットであれば、file_status(file_type::socket) を返します。
• もし 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) を返します。

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

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

Parameters

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

Return value

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

Exceptions

error_code& パラメータを取らないオーバーロードは、基盤となる OS API エラーが発生した場合に、最初の引数として p、エラーコード引数として OS エラーコードで構築された filesystem_error を投げます。メモリ割り当てに失敗した場合は、std::bad_alloc が投げられる可能性があります。 error_code& パラメータを取るオーバーロードは、OS API の呼び出しが失敗した場合にそれを OS API エラーコードに設定し、エラーが発生しなかった場合は ec.clear() を実行します。このオーバーロードは

noexcept 指定:  

noexcept

  

Notes

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

Example

このコードを実行

#include <cstdio>
#include <cstring>
#include <experimental/filesystem>
#include <fstream>
#include <iostream>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/un.h>
#include <unistd.h>
 
namespace fs = std::experimental::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

See also

file_status	ファイルの種別とパーミッションを表現する (クラス)
status_known	ファイルステータスが既知かどうかを確認する (関数)
is_block_file	指定されたパスがブロックデバイスを参照しているか確認する (関数)
is_character_file	指定されたパスがキャラクタデバイスを参照しているか確認する (関数)
is_directory	指定されたパスがディレクトリを参照しているか確認する (関数)
is_fifo	指定されたパスが名前付きパイプを参照しているか確認する (関数)
is_other	引数がその他のファイルを参照しているか確認する (関数)
is_regular_file	引数が通常ファイルを参照しているか確認する (関数)
is_socket	引数が名前付きIPCソケットを参照しているか確認する (関数)
is_symlink	引数がシンボリックリンクを参照しているか確認する (関数)
exists	パスが既存のファイルシステムオブジェクトを参照しているか確認する (関数)
statussymlink_status	このディレクトリエントリによって指定されたファイルのキャッシュされたステータス このディレクトリエントリによって指定されたファイルのキャッシュされた symlink_status (std::experimental::filesystem::directory_entry の public メンバ関数)