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 structstatvfs следующим образом:

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) Выбрасывает std::filesystem::filesystem_error при ошибках API базовой операционной системы; исключение создаётся с p в качестве первого аргумента пути и кодом ошибки ОС в качестве аргумента кода ошибки.

2) Если вызов API операционной системы завершается ошибкой, задаёт параметру std::error_code& код ошибки ОС; если ошибок нет, выполняет ec.clear().

Примечания

Значение space_info.available может быть меньше значения space_info.free.

Пример

#include <cstdint>
#include <filesystem>
#include <iostream>
#include <locale>

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)

информация о свободном и доступном пространстве файловой системы
(класс)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/filesystem/space