std::filesystem::rename

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (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 以 点 或 点点 结束。
• new_p 以目录分隔符结尾，指名一个不存在的目录。
• old_p 是一个目录，其祖先是 new_p。

参数

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

返回值

（无）

异常

若内存分配失败，则任何不标记为 noexcept 的重载可能抛出 std::bad_alloc 。

1) 抛出 std::filesystem::filesystem_error，构造时以 old_p 为第一路径实参，以 new_p 为第二路径实参，并以OS 错误码为错误码实参。

2) 若 OS API 调用失败，则设置 std::error_code& 为 OS API 错误码，而未发生错误时则执行 ec.clear()。

示例

Run this code

#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/"); // 错误："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

    std::filesystem::remove_all(p);
}

参阅

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