命名空间
变体
操作

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

来自 cppreference.cn
 
C++
 
文件系统库
类
函数
文件类型
 
定义于头文件 <filesystem>
(1) (C++17 起)
std::filesystem::file_status status( const std::filesystem::path& p,
                                     std::error_code& ec ) noexcept;
 (2) (C++17 起)
(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 - 非抛出重载中用于错误报告的出参

[编辑] 返回值

文件状态（一个 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;
    // alternative: 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()
{
    // create files of different kinds
    fs::create_directory("sandbox");
    fs::create_directory("sandbox/dir");
    std::ofstream{"sandbox/file"}; // create regular 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);
 
    // demo different status accessors
    for (auto it{fs::directory_iterator("sandbox")}; it != fs::directory_iterator(); ++it)
        demo_status(*it, it->symlink_status()); // use cached status from directory entry
    demo_status("/dev/null", fs::status("/dev/null")); // direct calls to status
    demo_status("/dev/sda", fs::status("/dev/sda"));
    demo_status("sandbox/no", fs::status("/sandbox/no"));
 
    // cleanup (prefer std::unique_ptr-based custom deleters)
    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

[编辑] 另请参阅

(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 的公开成员函数) [编辑]
取自 “https://cppreference.cn/mwiki/index.php?title=cpp/filesystem/status&oldid=180242”