Spec-Zone.ru › C++

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

std::filesystem::file_status status() const;
(1) (начиная с C++17)
std::filesystem::file_status status( std::error_code& ec ) const noexcept;
(2) (начиная с C++17)
std::filesystem::file_status symlink_status() const;
(3) (начиная с C++17)
std::filesystem::file_status symlink_status( std::error_code& ec ) const noexcept;
(4) (начиная с C++17)
1,2) Возвращает статус записи, как если бы он был определён вызовом filesystem::status (символические ссылки разрешаются до целевых объектов).
3,4) Возвращает статус записи, как если бы он был определён вызовом filesystem::symlink_status (символические ссылки не разрешаются).

Параметры

ec - выходной параметр для передачи сведений об ошибках в перегрузке, не генерирующей исключения

Возвращаемое значение

Статус файла, на который ссылается запись.

Исключения

Любая перегрузка, не помеченная noexcept, может выбросить std::bad_alloc при сбое выделения памяти.

1,3) Выбрасывает std::filesystem::filesystem_error при ошибках нижележащего API ОС; объект исключения создаётся с p в качестве первого аргумента-пути и кодом ошибки ОС в качестве аргумента кода ошибки.
2,4) При сбое вызова API ОС записывает код ошибки API ОС в параметр std::error_code&, а при отсутствии ошибок выполняет ec.clear().

Примечания

Многие низкоуровневые API ОС для обхода каталогов получают атрибуты файла вместе со следующей записью каталога. Конструкторы и неконстантные функции-члены std::filesystem::directory_iterator сохраняют эти атрибуты, если они имеются, в объект std::filesystem::directory_entry, на который указывает указатель, не вызывая directory_entry::refresh. Это позволяет изучать атрибуты записей каталога по мере их перебора без выполнения дополнительных системных вызовов.

Пример

#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

См. также

refresh
обновляет кэшированные атрибуты файла
(функция-член общего назначения)
exists
проверяет, ссылается ли запись каталога на существующий объект файловой системы
(функция-член общего назначения)
is_block_file
проверяет, ссылается ли запись каталога на блочное устройство
(функция-член общего назначения)
is_character_file
проверяет, ссылается ли запись каталога на символьное устройство
(функция-член общего назначения)
is_directory
проверяет, ссылается ли запись каталога на каталог
(функция-член общего назначения)
is_fifo
проверяет, ссылается ли запись каталога на именованный канал
(функция-член общего назначения)
is_other
проверяет, ссылается ли запись каталога на файл другого типа
(функция-член общего назначения)
is_regular_file
проверяет, ссылается ли запись каталога на обычный файл
(функция-член общего назначения)
is_socket
проверяет, ссылается ли запись каталога на именованный сокет IPC
(функция-член общего назначения)
is_symlink
проверяет, ссылается ли запись каталога на символическую ссылку
(функция-член общего назначения)
file_size
возвращает размер файла, на который ссылается запись каталога
(функция-член общего назначения)
hard_link_count
возвращает количество жёстких ссылок на файл, на который ссылается запись каталога
(функция-член общего назначения)
last_write_time
получает время последнего изменения данных файла, на который ссылается запись каталога
(функция-член общего назначения)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API