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

来自cppreference.com
 
C++
 
文件系统库
类
函数
文件类型
 
std::filesystem::directory_entry
成员函数
修改器
观察器
(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20)
非成员函数
 
std::filesystem::file_status status() const;
(1) (C++17 起) 
std::filesystem::file_status status( std::error_code& ec ) const noexcept;
(2) (C++17 起) 
std::filesystem::file_status symlink_status() const;
(3) (C++17 起) 
std::filesystem::file_status symlink_status( std::error_code& ec ) const noexcept;
(4) (C++17 起)
1,2) 返回条目的状态，如同用 std::filesystem::status 的调用确定（跟随符号链接至其目标）。
3,4) 返回条目的状态，如同用 std::filesystem::symlink_status 的调用确定（不跟随符号链接）。

参数

ec - 不抛出重载中报告错误的输出形参

返回值

条目所指代的文件的状态。

异常

若内存分配失败，则任何不标记为 noexcept 的重载可能抛出 std::bad_alloc 。

1,3) 抛出 std::filesystem::filesystem_error，构造时以 p 为第一路径实参并以OS 错误码为错误码实参。
2,4) 若 OS API 调用失败，则设置 std::error_code& 为 OS API 错误码，而未发生错误时则执行 ec.clear()。

注意

许多遍历目录的低层 OS API 将下个目录条目与文件属性一同获取。若它们存在，则 std::filesystem::directory_iterator 的构造函数和非 const 成员函数将这些属性存储于所指向的 std::filesystem::directory_entry 中，而不调用 directory_entry::refresh。这使得程序能够在迭代目录条目的同时检验其属性，而不进行额外的系统调用。

示例

运行此代码
#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 << " 是常规文件\n";
    if (fs::is_directory(s))
        std::cout << " 是目录\n";
    if (fs::is_block_file(s))
        std::cout << " 是块设备\n";
    if (fs::is_character_file(s))
        std::cout << " 是字符设备\n";
    if (fs::is_fifo(s))
        std::cout << " 是具名 IPC 管道\n";
    if (fs::is_socket(s))
        std::cout << " 是具名 IPC 套接字\n";
    if (fs::is_symlink(s))
        std::cout << " 是符号链接\n";
    if (!fs::exists(s))
        std::cout << " 不存在\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()); // 使用 directory_entry 缓存的状态
    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" 是常规文件
"sandbox/dir" 是目录
"sandbox/pipe" 是具名 IPC 管道
"sandbox/sock" 是具名 IPC 套接字
"sandbox/symlink" 是符号链接
"/dev/null" 是字符设备
"/dev/sda" 是块设备
"sandbox/no" 不存在

参阅

 更新缓存的文件属性
(公开成员函数)
检查 directory_entry 是否代表既存文件系统对象
(公开成员函数)
检查 directory_entry 是否代表块设备
(公开成员函数)
检查 directory_entry 是否代表字符设备
(公开成员函数)
检查 directory_entry 是否代表目录
(公开成员函数)
检查 directory_entry 是否代表具名管道
(公开成员函数)
检查 directory_entry 是否代表其他文件
(公开成员函数)
检查 directory_entry 是否代表常规文件
(公开成员函数)
检查 directory_entry 是否代表具名 IPC 套接字
(公开成员函数)
检查 directory_entry 是否代表符号链接
(公开成员函数)
返回 directory_entry 所指代的文件大小
(公开成员函数)
返回指代该 directory_entry 所表示的文件的硬链接数
(公开成员函数)
获取或设置 directory_entry 所代表的文件的最后数据修改时间
(公开成员函数)