Namespaces
Variants

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

From cppreference.net
C++
Filesystem library
Classes
Functions
File types
定义于头文件 <filesystem>
(1) (C++17 起)
(2) (C++17 起)
(3) (C++17 起)
(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;
    // 替代方案：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()); // 使用目录条目中的缓存状态
    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" 不存在

参见

(C++17)
表示文件类型和权限
(类)
(C++17)
检查文件状态是否已知
(函数)
(C++17)
检查给定路径是否指向块设备
(函数)
(C++17)
检查给定路径是否指向字符设备
(函数)
(C++17)
检查给定路径是否指向目录
(函数)
(C++17)
检查给定路径是否指向命名管道
(函数)
(C++17)
检查参数是否指向 其他 文件
(函数)
(C++17)
检查参数是否指向常规文件
(函数)
(C++17)
检查参数是否指向命名IPC套接字
(函数)
(C++17)
检查参数是否指向符号链接
(函数)
(C++17)
检查路径是否指向存在的文件系统对象
(函数)
此目录条目所指定文件的状态；
此目录条目所指定文件/符号链接的状态
( std::filesystem::directory_entry 的公开成员函数)