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 structstat было взято st_mode и преобразовано в тип std::filesystem::perms. - Если
pявляется обычным файлом (как при использовании POSIXS_ISREG), возвращаетfile_status(file_type::regular, prms). - Если
pявляется каталогом (как при использовании POSIXS_ISDIR), возвращаетfile_status(file_type::directory, prms). - Если
pявляется специальным блочным файлом (как при использовании POSIXS_ISBLK), возвращаетfile_status(file_type::block, prms). - Если
pявляется специальным символьным файлом (как при использовании POSIXS_ISCHR), возвращаетfile_status(file_type::character, prms). - Если
pявляется файлом FIFO или каналом (как при использовании POSIXS_ISFIFO), возвращаетfile_status(file_type::fifo, prms). - Если
pявляется сокетом (как при использовании POSIXS_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) При ошибках нижележащего API ОС выбрасывает
std::filesystem::filesystem_error, конструируемое с 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
См. также
|
(C++17) | представляет тип и разрешения файла (класс) |
|
(C++17) | проверяет, известно ли состояние файла (функция) |
|
(C++17) | проверяет, указывает ли заданный путь на блочное устройство (функция) |
|
(C++17) | проверяет, указывает ли заданный путь на символьное устройство (функция) |
|
(C++17) | проверяет, указывает ли заданный путь на каталог (функция) |
|
(C++17) | проверяет, указывает ли заданный путь на именованный канал (функция) |
|
(C++17) | проверяет, указывает ли аргумент на файл другого типа (функция) |
|
(C++17) | проверяет, указывает ли аргумент на обычный файл (функция) |
|
(C++17) | проверяет, указывает ли аргумент на именованный сокет IPC (функция) |
|
(C++17) | проверяет, указывает ли аргумент на символическую ссылку (функция) |
|
(C++17) | проверяет, указывает ли путь на существующий объект файловой системы (функция) |
| состояние файла, указанного этой записью каталога; состояние файла/символической ссылки, указанного этой записью каталога (открытая функция-член std::filesystem::directory_entry) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/filesystem/status