RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://en.cppreference.com/w/cpp/algorithm/../error/../../cpp/filesystem/is_regular_file.html below:

std::filesystem::is_regular_file - cppreference.com

Checks if the given file status or path corresponds to a regular file.

1) Equivalent to s.type() == file_type::regular.

2,3) Equivalent to is_regular_file(status(p)) or is_regular_file(status(p, ec)) respectively.

[edit] Parameters s - file status to check p - path to examine ec - error code to store the error status to [edit] Return value

true if the file indicated by p or if the type indicated by s refers to a regular file, false otherwise. The non-throwing overload returns false if an error occurs.

[edit] Exceptions

Any overload not marked noexcept may throw std::bad_alloc if memory allocation fails.

2,3)

Sets a

std::error_code&

parameter to the OS API error code if an OS API call fails, and executes

ec.clear()

if no errors occur.

[edit] Notes

The throwing overload is additionally specified to throw std::filesystem::filesystem_error if status(p) would throw.

[edit] Example

#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");
}

Possible output:

"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

[edit] See also the type of a file
(enum) [edit] determines file attributes
determines file attributes, checking the symlink target
(function) [edit] represents file type and permissions
(class) [edit] checks whether file status is known
(function) [edit] checks whether the given path refers to block device
(function) [edit] checks whether the given path refers to a character device
(function) [edit] checks whether the given path refers to a directory
(function) [edit] checks whether the given path refers to a named pipe
(function) [edit] checks whether the argument refers to an other file
(function) [edit] checks whether the argument refers to a named IPC socket
(function) [edit] checks whether the argument refers to a symbolic link
(function) [edit] checks whether path refers to existing file system object
(function) [edit] checks whether the directory entry refers to a regular file
(public member function of std::filesystem::directory_entry) [edit]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4