std::filesystem::rename

ヘッダー `<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 で識別されるファイルシステムオブジェクトを、POSIX の rename と同様に、 new_p へ移動または名前変更します。

もし 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 の祖先であるディレクトリの場合。

1) 基盤となる OS API エラーが発生した場合、 std::filesystem::filesystem_error をスローします。この例外は、最初のパス引数として old_p、2番目のパス引数として new_p、エラーコード引数として OS のエラーコードが指定されて構築されます。

2) OS API呼び出しが失敗した場合、std::error_code& パラメータにOS 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)	ファイルまたは空のディレクトリを削除するファイルまたはディレクトリとその内容をすべて再帰的に削除する (関数) [編集]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

cppreference.com

名前空間

変種

表示

操作

std::filesystem::rename

目次

[編集] パラメータ

[編集] 戻り値

[編集] 例外

[編集] 例

[編集] 関連項目

ナビゲーション

ツールボックス

old_p	-	移動または名前変更するパス
new_p	-	移動/名前変更操作のターゲットパス
エラーコード	-	例外を投げないオーバーロードでのエラー報告のための出力パラメータ