std::experimental::filesystem::rename
来自cppreference.com
| 在标头 <experimental/filesystem> 定义
|
||
| |
(文件系统 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& 形参的重载,在发生底层 OS API 错误时抛出 filesystem_error,它以 old_p 为第一实参,以 new_p 为第二实参,并以 OS 错误码为错误码实参构造。如果内存分配失败,则可抛出 std::bad_alloc。接受 error_code& 形参的重载,当 OS API 调用失败时将之设置为 OS 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/"); // 错误: 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);
}
参阅
| 重命名文件 (函数) | |
| 移除一个文件或空目录 移除一个文件或递归地移除一个目录与其全部内容 (函数) |