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

Определено в заголовке `<filesystem>`
std::filesystem::file_status status( const std::filesystem::path& p );	(1)	(с C++17)
std::filesystem::file_status status( const std::filesystem::path& p, std::error_code& ec ) noexcept;	(2)	(с C++17)
std::filesystem::file_status symlink_status( const std::filesystem::path& p );	(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) Выбрасывает std::filesystem::filesystem_error при ошибках в подлежащей API операционной системы, созданной с p в качестве первого аргумента пути и кодом ошибки ОС в качестве аргумента ошибки.

2,4) Устанавливает параметр std::error_code& в код ошибки API операционной системы, если вызов 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

См. также

file_status (C++17)	представляет тип и разрешения файла (класс)
status_known (C++17)	проверяет, известен ли статус файла (функция)
is_block_file (C++17)	проверяет, ссылается ли заданный путь на устройство блочного ввода-вывода (функция)
is_character_file (C++17)	проверяет, ссылается ли заданный путь на устройство символьного ввода-вывода (функция)
is_directory (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)	проверяет, ссылается ли путь на существующий объект файловой системы (функция)
statussymlink_status	статус файла, указанного в этом элементе каталога; статус файла/символьной ссылки, указанного в этом элементе каталога (публичный член-функция `std::filesystem::directory_entry`)

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