std::filesystem::rename

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (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 以 dot 或 dot-dot 結尾。
• new_p 命名了一個不存在且以目錄分隔符結尾的目錄。
• old_p 是 new_p 的祖先目錄。

引數

old_p	-	要移動或重新命名的路徑
new_p	-	移動/重新命名操作的目標路徑
ec	-	非丟擲過載中用於錯誤報告的出參

返回值

(無)

異常

任何未標記為 noexcept 的過載都可能在記憶體分配失敗時丟擲 std::bad_alloc。

1) 在底層作業系統 API 錯誤時丟擲 std::filesystem::filesystem_error，構造時以 old_p 作為第一個路徑引數，new_p 作為第二個路徑引數，作業系統錯誤程式碼作為錯誤程式碼引數。

2) 如果作業系統 API 呼叫失敗，則將 std::error_code& 引數設定為作業系統 API 錯誤程式碼；如果未發生錯誤，則執行 ec.clear()。

示例

執行此程式碼

#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/"); // 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
 
    std::filesystem::remove_all(p);
}

參閱

rename	重新命名檔案 (函式)
removeremove_all (C++17)(C++17)	刪除檔案或空目錄 刪除檔案或目錄及其所有內容，遞迴進行 (函式)