- filesystem[meta header]
- std::filesystem[meta namespace]
- function[meta id-type]
- cpp17[meta cpp]
namespace std::filesystem {
bool copy_file(const path& from, const path& to); // (1)
bool copy_file(const path& from, const path& to, std::error_code& ec); // (2)
bool copy_file(const path& from, const path& to, copy_options options); // (3)
bool copy_file(const path& from, const path& to, copy_options options,
std::error_code& ec); // (4)
}- path[link path.md]
- copy_options[link copy_options.md]
ファイルをコピーする。
optionsは、各グループのオプションが最大ひとつまで設定されていること
- (1) :
return copy_file(from, to,copy_options::none); - (2) :
return copy_file(from, to,copy_options::none, ec); - (3) :
- 以下のいずれか場合にエラーとなる:
!is_regular_file(from)(コピー元のファイルが存在しない)exists(to) && !is_regular_file(to)(コピー先に、通常ファイルではないファイルが存在している)exists(to) &&equivalent(from, to)(コピー先にファイルが存在しており、それがコピー元と等価)exists(to) && (options & (copy_options::skip_existing|copy_options::overwrite_existing|copy_options::update_existing)) ==copy_options::none(コピー先にファイルが存在しており、その場合にエラーにならないオプションが指定されていない)
- 以下の条件のいずれかに合致する場合、パス
fromが解決したファイルを、パスtoが解決した先にコピーする!exists(to)(options ©_options::overwrite_existing) !=copy_options::none(options ©_options::update_existing) !=copy_options::none、かつパスfromのファイルが、パスtoのファイルよりも最終更新日時が新しい
- そうでない場合、なにもしない
- 以下のいずれか場合にエラーとなる:
- (4) : (3)でエラーが発生した場合に、
falseを返し、エラー情報をecに設定する
ファイルのコピーが行われたらtrue、そうでなければfalseが返る。
(2)と(4)でエラーが発生した場合もfalseが返る。
直接的もしくは間接的なstatus(to)の呼び出しは、最大で一回
- (1), (3) : ファイルシステムがエラーを報告する場合がある。エラーが発生した場合は、
std::filesystem::filesystem_error例外を送出する - (2), (4) : OSがファイルコピーの直接のAPIを定義していない場合、この関数の実装として動的なバッファを確保する可能性がある。その際、メモリ確保で例外が発生する可能性がある
#include <cassert>
#include <filesystem>
#include <fstream>
namespace fs = std::filesystem;
int main()
{
std::ofstream{"regular.txt"};
// ファイル"regular.txt"を、"copy.txt"にコピーする
fs::copy_file("regular.txt", "copy.txt");
assert(fs::exists("regular.txt"));
assert(fs::exists("copy.txt"));
// 同じパスではなく、シンボリックリンク/ハードリンクでもないので、等価ではない
assert(!fs::equivalent("regular.txt", "copy.txt"));
}- fs::copy_file[color ff0000]
- fs::exists[link exists.md]
- fs::equivalent[link equivalent.md]
- C++17
- Clang: 7.0 [mark verified]
- GCC: 8.1 [mark verified]
- Visual C++: