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

std::filesystem::directory_entry::replace_filename: std::filesystem::directory_entry::replace_filename

NAME

std::filesystem::directory_entry::replace_filename - std::filesystem::directory_entry::replace_filename

Synopsis


void replace_filename( const std::filesystem::path& p ); (since C++17)
void replace_filename( const std::filesystem::path& p, std::error_code& ec );


Changes the filename of the directory entry.
Effectively modifies the path member by path.replace_filename(p) and calls refresh to update the cached attributes. If an error occurs, the values of the cached attributes are unspecified.
This function does not commit any changes to the filesystem.

Parameters


p - the path to append to the parent path of the currently stored path
ec - out-parameter for error reporting in the non-throwing overload

Return value


(none)

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


                 assigns contents
assign (public member function)
                 replaces the last path component with another path
replace_filename (public member function of std::filesystem::path)