std::filesystem::directory_entry::is_fifo (3) - Linux Man Pages

std::filesystem::directory_entry::is_fifo: std::filesystem::directory_entry::is_fifo

NAME

std::filesystem::directory_entry::is_fifo - std::filesystem::directory_entry::is_fifo

Synopsis


bool is_fifo() const; (since C++17)
bool is_fifo( std::error_code& ec ) const noexcept;


Checks whether the pointed-to object is a FIFO or pipe file. Effectively returns std::filesystem::is_fifo(status()) or std::filesystem::is_fifo(status(ec)), respectively

Parameters


ec - out-parameter for error reporting in the non-throwing overload

Return value


true if the referred-to filesystem object is a FIFO or pipe file, false otherwise.

Exceptions


The overload that does not take a std::error_code& parameter throws filesystem_error on underlying OS API errors, constructed with p as the first path argument and the OS error code as the error code argument. The overload taking a std::error_code& parameter sets it to the OS API error code if an OS API call fails, and executes ec.clear() if no errors occur. Any overload not marked noexcept may throw std::bad_alloc if memory allocation fails.

Example


 This section is incomplete
 Reason: no example

See also


is_fifo checks whether the given path refers to a named pipe
        (function)
(C++17)