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

 
C++
 
文件系统库
类
函数
文件类型
 
std::filesystem::directory_entry
directory_entry::statusdirectory_entry::symlink_status
(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20)
 
std::filesystem::file_status status() const;
std::filesystem::file_status status( std::error_code& ec ) const noexcept;
 (1) (C++17 起)
std::filesystem::file_status symlink_status() const;
std::filesystem::file_status symlink_status( std::error_code& ec ) const noexcept;
 (2) (C++17 起)
1) 返回入口的状态，如同用 status 的调用确定（跟随符号链接至其目标）
2) 返回入口的状态，如同用 symlink_status 的调用确定（不跟随符号链接）

参数

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

返回值

入口所指代的文件的状态。

异常

不接受 std::error_code& 参数的重载在底层 OS API 错误时抛出 filesystem_error ，以第一 path 参数 p 和作为错误码参数的 OS 错误码构造。若 OS API 调用失败，则接受 std::error_code& 参数的重载设置该参数为 OS API 错误码，而若不出现错误则执行 ec.clear() 。若内存分配失败，则任何不标记为 noexcept 的重载可能抛出 std::bad_alloc 。

注意

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

示例

运行此代码
#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;
    // 变体： 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()
{
    // 创建不同种类的文件
    fs::create_directory("sandbox");
    std::ofstream("sandbox/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");
 
    // 演示不同的状态访问器
    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"));
 
    // 清理
    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

参阅

 更新缓存的文件属性
(公开成员函数)
检查 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 所代表的文件的最后数据修改时间
(公开成员函数)