std::experimental::filesystem::rename

 

C++

编译器支持

独立和宿主

语言

标准库

标准库头文件

命名需求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

实验性

技术规范

文件系统库 (文件系统 TS)

库基础 (库基础 TS)

库基础 2 (库基础 TS v2)

库基础 3 (库基础 TS v3)

并行扩展 (并行 TS)

并行扩展 2 (并行 TS v2)

并发扩展 (并发 TS)

并发扩展 2 (并发 TS v2)

概念 (概念 TS)

范围 (范围 TS)

反射 (反射 TS)

数学特殊函数 (特殊函数 TR)

实验性非 TS

模式匹配

线性代数

std::execution

契约

二维图形

 

文件系统库

类
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::perms filesystem::copy_options filesystem::directory_options filesystem::file_time_type
函数
filesystem::absolute filesystem::system_complete filesystem::canonical 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::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::temp_directory_path
文件类型
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

 

在头文件 <experimental/filesystem> 中定义
void rename( const path& old_p, const path& new_p ); void rename( const path& old_p, const path& new_p, std::error_code& ec );		(文件系统 TS)

将由 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	-	非抛出重载中用于错误报告的输出参数

返回值

(无)

异常

不接受 error_code& 参数的重载在底层操作系统 API 错误时抛出 filesystem_error，使用 old_p 作为第一个参数，new_p 作为第二个参数，以及操作系统错误代码作为错误代码参数构造。如果内存分配失败，则可能会抛出 std::bad_alloc。接受 error_code& 参数的重载在操作系统 API 调用失败时将其设置为操作系统 API 错误代码，如果未发生错误，则执行 ec.clear()。此重载具有

noexcept 规范：  

noexcept

  

示例

运行此代码

#include <experimental/filesystem>
#include <fstream>
#include <iostream>
namespace fs = std::experimental::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/"); // 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
 
    fs::remove_all(p);
}

另请参阅

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