close

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

来自cppreference.com
 
C++
 
文件系统库
类
函数
文件类型
 
在标头 <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 - 不抛出重载中报告错误的输出形参

返回值

文件状态（一个 std::filesystem::file_status 对象）

异常

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

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

注解

此函数提供的信息通常也作为目录迭代的副产物提供，而且可能为 std::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()); // 使用 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" 不存在

参阅

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