std::filesystem::space

定义在头文件 `<filesystem>` 中
std::filesystem::space_info space( const std::filesystem::path& p );	(1)	(自 C++17 起)
std::filesystem::space_info space( const std::filesystem::path& p, std::error_code& ec ) noexcept;	(2)	(自 C++17 起)

确定路径名 p 所在的文件系统的相关信息，如同使用 POSIX statvfs.

填充并返回一个类型为 filesystem::space_info 的对象，该对象从 POSIX struct statvfs 的成员中设置，如下所示

space_info.capacity 被设置成 f_blocks * f_frsize。
space_info.free 被设置为 f_bfree * f_frsize。
space_info.available 被设置为 f_bavail * f_frsize。
任何无法确定的成员都将设置为 static_cast<std::uintmax_t>(-1)。

非抛出重载在错误时将所有成员设置为 static_cast<std::uintmax_t>(-1)。

[编辑] 参数

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

[编辑] 返回值

文件系统信息（一个 filesystem::space_info 对象）。

[编辑] 异常

任何没有标记为 noexcept 的重载都可能在内存分配失败时抛出 std::bad_alloc。

1) 在底层操作系统 API 错误上抛出 std::filesystem::filesystem_error，使用 p 作为第一个路径参数，操作系统错误代码作为错误代码参数构造。

2) 如果操作系统 API 调用失败，则将 std::error_code& 参数设置为操作系统 API 错误代码，如果未发生错误，则执行 ec.clear()。

[编辑] 备注

space_info.available 可能小于 space_info.free。

[编辑] 示例

运行此代码

#include <cstdint>
#include <filesystem>
#include <iostream>
 
std::uintmax_t disk_usage_percent(const std::filesystem::space_info& si,
                                  bool is_privileged = false) noexcept
{
    if (constexpr std::uintmax_t X(-1);
        si.capacity == 0 || si.free == 0 || si.available == 0 ||
        si.capacity == X || si.free == X || si.available == X
    )
        return 100;
 
    std::uintmax_t unused_space = si.free, capacity = si.capacity;
    if (!is_privileged)
    {
        const std::uintmax_t privileged_only_space = si.free - si.available;
        unused_space -= privileged_only_space;
        capacity -= privileged_only_space;
    }
    const std::uintmax_t used_space{capacity - unused_space};
    return 100 * used_space / capacity;
}
 
void print_disk_space_info(auto const& dirs, int width = 14)
{
    (std::cout << std::left).imbue(std::locale("en_US.UTF-8"));
 
    for (const auto s : {"Capacity", "Free", "Available", "Use%", "Dir"})
        std::cout << "│ " << std::setw(width) << s << ' ';
 
    for (std::cout << '\n'; auto const& dir : dirs)
    {
        std::error_code ec;
        const std::filesystem::space_info si = std::filesystem::space(dir, ec);
        for (auto x : {si.capacity, si.free, si.available, disk_usage_percent(si)})
            std::cout << "│ " << std::setw(width) << static_cast<std::intmax_t>(x) << ' ';
        std::cout << "│ " << dir << '\n';
    }
}
 
int main()
{
    const auto dirs = {"/dev/null", "/tmp", "/home", "/proc", "/null"};
    print_disk_space_info(dirs);
}

可能的输出

│ Capacity       │ Free           │ Available      │ Use%           │ Dir            
│ 84,417,331,200 │ 42,732,986,368 │ 40,156,028,928 │ 50             │ /dev/null
│ 84,417,331,200 │ 42,732,986,368 │ 40,156,028,928 │ 50             │ /tmp
│ -1             │ -1             │ -1             │ 100            │ /home
│ 0              │ 0              │ 0              │ 100            │ /proc
│ -1             │ -1             │ -1             │ 100            │ /null

[编辑] 另请参阅

space_info

(C++17)

有关文件系统上可用和空闲空间的信息
(class) [编辑]

编译器支持
独立和托管
语言
标准库
标准库头文件
命名需求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用实用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

cppreference.com

命名空间

变体

视图

操作