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

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

实验性

技术规范

文件系统库 (文件系统 TS)

库基础 (库基础 TS)

库基础 2 (库基础 TS v2)

库基础 3 (库基础 TS v3)

并行扩展 (并行 TS)

并行扩展 2 (并行 TS v2)

并发扩展 (并发 TS)

并发扩展 2 (并发 TS v2)

概念 (概念 TS)

范围 (范围 TS)

反射 (反射 TS)

数学特殊函数 (特殊函数 TR)

实验性非 TS 功能特性

模式匹配

线性代数

std::execution

契约

2D 图形

 

文件系统库

类
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::perms filesystem::copy_options filesystem::directory_options filesystem::file_time_type
函数
filesystem::absolute filesystem::system_complete filesystem::canonical 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::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::temp_directory_path
文件类型
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

 

在标头 <experimental/filesystem> 定义
file_status status( const path& p ); file_status status( const path& p, error_code& ec ) noexcept;	(1)	(文件系统 TS)
file_status symlink_status( const path& p ); file_status symlink_status( const path& p, error_code& ec ) noexcept;	(2)	(文件系统 TS)

1) 确定由 p 标定的文件系统对象的类型和属性，如同通过 POSIX stat 进行（跟随符号链接到其目标）。

• 若 p 是常规文件，则返回 file_status(file_type::regular)。
• 若 p 是目录，则返回 file_status(file_type::directory)。
• 若 p 是块特殊文件，则返回 file_status(file_type::block)。
• 若 p 是字符特殊文件，则返回 file_status(file_type::character)。
• 若 p 是 fifo 或管道文件，则返回 file_status(file_type::fifo)。
• 若 p 是套接字，则返回 file_status(file_type::socket)。
• 若 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)。

2) 与 (1) 相同，但其行为如同使用 POSIX lstat（不跟随符号链接）：

• 若 p 为符号链接，则返回 file_status(file_type::symlink)。

参数

p	-	要检查的路径
ec	-	用于无抛出重载中错误报告的输出形参

返回值

文件状态（file_status 对象）。

异常

不接受 error_code& 形参的重载，在发生底层 OS API 错误时抛出 filesystem_error，它以 p 为第一实参并以 OS 错误码为错误码实参构造。如果内存分配失败，则可抛出 std::bad_alloc。接受 error_code& 形参的重载，当 OS API 调用失败时将之设置为 OS API 错误码，而未发生错误时执行 ec.clear()。此重载具有

noexcept 规定：  

noexcept

  

注解

此函数提供的信息通常也是目录遍历所提供的副产物，且可以通过 directory_entry 的成员函数获得。遍历目录时，无需再次调用 status。

示例

Run this code

#include <cstdio>
#include <cstring>
#include <experimental/filesystem>
#include <fstream>
#include <iostream>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/un.h>
#include <unistd.h>

namespace fs = std::experimental::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");
    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()); // 使用目录项中缓存的状态
    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" 是常规文件
"sandbox/dir" 是目录
"sandbox/pipe" 是命名 IPC 管道
"sandbox/sock" 是命名 IPC 套接字
"sandbox/symlink" 是符号链接
"dev/null" 是字符设备
"dev/sda" 是块设备
"sandbox/no" 不存在

参阅

file_status	表示文件类型及权限 (类)
status_known	检查文件状态是否已知 (函数)
is_block_file	检查给定路径是否指代块设备 (函数)
is_character_file	检查给定路径是否指代字符设备 (函数)
is_directory	检查给定路径是否指代一个目录 (函数)
is_fifo	检查给定路径是否指代一个命名管道 (函数)
is_other	检查参数是否指代一个其他文件 (函数)
is_regular_file	检查实参是否指代一个常规文件 (函数)
is_socket	检查实参是否指代一个具名 IPC 套接字 (函数)
is_symlink	检查实参是否指代一个符号链接 (函数)
exists	检查路径是否指代既存的文件系统对象 (函数)
statussymlink_status	缓存的此目录项所代表的文件的 status 缓存的此目录项所代表的文件的 symlink_status (std::experimental::filesystem::directory_entry 的公开成员函数)