std::filesystem::rename

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文件系统库

类
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator    filesystem::file_status filesystem::space_info	filesystem::file_type filesystem::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
函数
filesystem::absolute filesystem::canonicalfilesystem::weakly_canonical filesystem::relativefilesystem::proximate filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path filesystem::temp_directory_path	filesystem::exists filesystem::equivalent filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status
文件类型
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

 

定义于头文件 <filesystem>
void rename( const std::filesystem::path& old_p,              const std::filesystem::path& new_p );	(1)	(C++17 起)
void rename( const std::filesystem::path& old_p,              const std::filesystem::path& new_p,              std::error_code& ec ) noexcept;	(2)	(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_p 以 dot 或 dot-dot 结尾。
• new_p 命名了一个不存在且以目录分隔符结尾的目录。
• old_p 是 new_p 的祖先目录。

参数

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

返回值

(无)

异常

任何未标记为 noexcept 的重载都可能在内存分配失败时抛出 std::bad_alloc。

1) 在底层操作系统 API 错误时抛出 std::filesystem::filesystem_error，构造时以 old_p 作为第一个路径参数，new_p 作为第二个路径参数，操作系统错误代码作为错误代码参数。

2) 如果操作系统 API 调用失败，则将 std::error_code& 参数设置为操作系统 API 错误代码；如果未发生错误，则执行 ec.clear()。

示例

运行此代码

#include <filesystem>
#include <fstream>
namespace fs = std::filesystem;
 
int main()
{
    std::filesystem::path p = std::filesystem::current_path() / "sandbox";
    std::filesystem::create_directories(p / "from");
    std::ofstream{ p / "from/file1.txt" }.put('a');
    std::filesystem::create_directory(p / "to");
 
//  fs::rename(p / "from/file1.txt", p / "to/"); // error: "to" is a directory
    fs::rename(p / "from/file1.txt", p / "to/file2.txt"); // OK
//  fs::rename(p / "from", p / "to"); // error: "to" is not empty
    fs::rename(p / "from", p / "to/subdir"); // OK
 
    std::filesystem::remove_all(p);
}

参阅

rename	重命名文件 (函数)
removeremove_all (C++17)(C++17)	删除文件或空目录 删除文件或目录及其所有内容，递归进行 (函数)