# std::filesystem::is_directory

< cpp‎ | filesystem

定义于头文件 `<filesystem>` |  |
bool is_directory( std::filesystem::file_status s ) noexcept; | (1) | (C++17 起)
bool is_directory( const std::filesystem::path& p ); bool is_directory( const std::filesystem::path& p, std::error_code& ec ) noexcept; | (2) | (C++17 起)

检查给定文件状态或路径是否对应一个目录。

1) 等价于 s.type() == file_type::directory 。
2) 分别等价于 is_directory(status(p)) 或 is_directory(status(p, ec)) 。

### 参数

s | - | 要检查的文件状态
p | - | 要查询的路径
ec | - | 不抛出重载中报告错误的输出参数

### 返回值

若 `p` 所指示的文件或 `s` 所指示的类型指代目录则为 true ，否则为 false 。不抛出重载在错误发生时返回 false 。

### 异常

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

### 示例

    #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

### 参阅

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