命名空间
变体
操作

std::experimental::filesystem::rename

来自 cppreference.cn
< cpp‎ | experimental‎ | fs
 
 
实验性
技术规范
文件系统库 (文件系统 TS)
库基础 (库基础 TS)
库基础 2 (库基础 TS v2)
库基础 3 (库基础 TS v3)
并行性扩展 (并行性 TS)
并行性扩展 2 (并行性 TS v2)
并发性扩展 (并发性 TS)
并发扩展 2 (并发 TS v2)
概念 (概念 TS)
范围 (范围 TS)
反射 (反射 TS)
数学特殊函数 (特殊函数 TR)
实验性非 TS
模式匹配
线性代数
std::execution
契约
2D 图形
 
 
定义于头文件 <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_pnew_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);
}

[编辑] 另请参阅

重命名文件
(函数) [编辑]
删除文件或空目录
删除文件或目录及其所有内容,递归进行
(函数) [编辑]