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

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

檔案系統庫

類
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::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
函式
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::temp_directory_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::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

 

定義於標頭檔案 <filesystem>
std::filesystem::file_status status( const std::filesystem::path& p );	(1)	(C++17 起)
std::filesystem::file_status status( const std::filesystem::path& p,                                      std::error_code& ec ) noexcept;	(2)	(C++17 起)
std::filesystem::file_status symlink_status( const std::filesystem::path& p );	(3)	(C++17 起)
std::filesystem::file_status symlink_status( const std::filesystem::path& p,                                              std::error_code& ec ) noexcept;	(4)	(C++17 起)

1,2) 確定由 p 標識的檔案系統物件的型別和屬性，如同透過 POSIX stat （符號連結被跟蹤到其目標）。在以下描述中，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) 在底層作業系統 API 錯誤時丟擲 std::filesystem::filesystem_error，構造時以 p 作為第一個路徑引數，作業系統錯誤碼作為錯誤碼引數。

2,4) 如果作業系統 API 呼叫失敗，將 std::error_code& 引數設定為作業系統 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;
    // 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

另請參閱

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 的公開成員函式)