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

 

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

 

directory_entry

Template:cpp/experimental/fs/directory entry/navbar content

 

file_status status() const; file_status status( error_code& ec ) const;	(1)	(filesystem TS)
file_status symlink_status() const; file_status symlink_status( error_code& ec ) const;	(2)	(filesystem TS)

1) エントリの、キャッシュされた可能性のあるステータスを返します。これは、status 呼び出しによって決定されたかのように動作します（シンボリックリンクはターゲットに追跡されます）。

2) エントリの、キャッシュされた可能性のあるステータスを返します。これは、symlink_status 呼び出しによって決定されたかのように動作します（シンボリックリンクは追跡されません）。

パラメータ

エラーコード

-

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

戻り値

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

例外

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

noexcept 指定:  

noexcept

  

注記

ファイルステータス情報は、通常、ディレクトリ反復の副産物として提供されます。その場合、キャッシュされ、追加のシステムコールなしでこれらのメンバ関数によって取得できます。ディレクトリ反復中、status の呼び出しは不要であり、is_directory のようなアクセサは、パスではなく、キャッシュされたステータス値で呼び出すべきです。

例

このコードを実行

#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

関連項目

file_status	ファイルの種別とパーミッションを表現する (クラス)
statussymlink_status	ファイルの属性を決定する シンボリックリンクのターゲットを確認してファイルの属性を決定する (関数)
status_known	ファイルステータスが既知かどうかを確認する (関数)
is_block_file	指定されたパスがブロックデバイスを参照しているか確認する (関数)
is_character_file	指定されたパスがキャラクタデバイスを参照しているか確認する (関数)
is_directory	指定されたパスがディレクトリを参照しているか確認する (関数)
is_fifo	指定されたパスが名前付きパイプを参照しているか確認する (関数)
is_other	引数がその他のファイルを参照しているか確認する (関数)
is_regular_file	引数が通常ファイルを参照しているか確認する (関数)
is_socket	引数が名前付きIPCソケットを参照しているか確認する (関数)
is_symlink	引数がシンボリックリンクを参照しているか確認する (関数)