std::experimental::filesystem::rename
来自 cppreference.cn
< cpp | experimental | fs
| 定义于头文件 <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 以 dot 或 dot-dot 结尾。
- 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/"); // 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); }
[编辑] 参见
| 重命名文件 (函数) | |
| 移除文件或空目录 递归地移除文件或目录及其所有内容 (函数) |
