std::filesystem::rename

来自cppreference.com
 
 
 
定义于头文件 <filesystem>
void rename(const std::filesystem::path& old_p,

            const std::filesystem::path& new_p);
void rename(const std::filesystem::path& old_p,
            const std::filesystem::path& new_p,

            std::error_code& ec);
(C++17 起)

移动或重命名 old_p 所标识的文件系统对象到 new_p ,如同用 POSIX rename

  • old_p 是非目录文件,则 new_p 必须是下列之一:
  • old_p 为相同文件,或到它的硬链接:此情况不做任何事
  • 既存的非目录文件: new_p 首先被删除,然后因为删除不允许其他进程观测 new_p ,并将路径名 new_p 链接到该文件,而 old_p 从该文件接触链接。要求含有 old_p 的目录和含有 new_p 的目录的写权限。
  • 既存目录中的不存在文件:链接路径名 new_p 到该文件,并从该文件解链接 old_p 。要求含有 old_p 的目录和含有 new_p 的目录的写权限。
  • old_p 是目录,则 new_p 必须是下列之一:
  • old_p 为相同文件或到它的硬链接:此情况不做任何事
  • 既存目录:在 POSIX 系统上若 new_p 为空则删除之,但这在其他系统上可能是错误。若费错误,则首先删除 new_p ,然后因为删除不允许其他进程观测 new_p ,并将路径名 new_p 链接到该目录,将 old_p 从该目录解除链接。要求含有 old_p 的目录和含有 new_p 的目录的写权限。
  • 不存在的目录,不以目录分隔符终止,且亲目录存在:将路径名 new_p 链接到该目录,且从该目录解链接 old_p 。要求含有 old_p 的目录和含有 new_p 的目录的写权限。
  • 不跟随符号链接:若 old_p 是符号链接,则重命名它自身,而非其目标。若 new_p 是既存符号链接,则删除它自身,而非其目标。

若有如下情况则重命名失败

  • new_pdotdot-dot 结束
  • new_p 以目录分隔符结尾,指名一个不存在的目录
  • old_p 是一个目录,其祖先是 new_p

目录

[编辑] 参数

old_p - 要移动或重命名的路径
new_p - 移动/重命名操作的目标路径
ec - 不抛出重载中报告错误的输出参数

[编辑] 返回值

(无)

[编辑] 异常

不接受 std::error_code& 参数的重载在底层 OS API 错误时抛出 filesystem_error ,以第一 path 参数 old_p,第二 path 参数 new_p 和作为错误码参数的 OS 错误码构造。若 OS API 调用失败,则接受 std::error_code& 参数的重载设置该参数为 OS API 错误码,而若不出现错误则执行 ec.clear() 。若内存分配失败,则任何不标记为 noexcept 的重载可能抛出 std::bad_alloc

[编辑] 示例

#include <iostream>
#include <fstream>
#include <filesystem>
namespace fs = std::filesystem;
int main()
{
    fs::path p = fs::current_path() / "sandbox";
    fs::create_directories(p/"from");
    std::ofstream(p/"from/file1.txt").put('a');
    fs::create_directory(p/"to");
 
//    fs::rename(p/"from/file1.txt", p/"to/"); // 错误: to 是目录
    fs::rename(p/"from/file1.txt", p/"to/file2.txt"); // OK
//    fs::rename(p/"from", p/"to"); // 错误: to 非空
    fs::rename(p/"from", p/"to/subdir"); // OK
 
    fs::remove_all(p);
}


[编辑] 参阅

重命名文件
(函数) [编辑]
(C++17)(C++17)
移除一个文件或空目录
移除一个文件或递归地移除一个目录及其所有内容
(函数) [编辑]