命名空间
变体
操作

std::filesystem::copy_file

来自 cppreference.cn
 
C++
 
文件系统库
类
函数
文件类型
 
定义于头文件 <filesystem>
bool copy_file( const std::filesystem::path& from,
                const std::filesystem::path& to );
 (1) (C++17 起)
bool copy_file( const std::filesystem::path& from,

                const std::filesystem::path& to,

                std::error_code& ec );
 (2) (C++17 起)
bool copy_file( const std::filesystem::path& from,

                const std::filesystem::path& to,

                std::filesystem::copy_options options );
 (3) (C++17 起)
bool copy_file( const std::filesystem::path& from,

                const std::filesystem::path& to,
                std::filesystem::copy_options options,

                std::error_code& ec );
 (4) (C++17 起)
1,2) 默认值，等价于使用 `copy_options::none` 作为 `options` 的 (3,4)。
3,4) 使用 `options` 中指示的复制选项，将单个文件从 `from` 复制到 `to`。如果在 `options` 中存在任何 copy_options 选项组中的多个选项（即使是与 filesystem::copy_file 不相关的组），则行为未定义。
  • 则将 `from` 解析到的文件的内容和属性复制到 `to` 解析到的文件（遵循符号链接）。
  • 否则，如果目标文件已存在，
  • 如果以下任何一项为真，则报告错误：
  • 否则，如果 `options` 中设置了 `copy_options::skip_existing`，则不执行任何操作。
  • 否则，如果 `options` 中设置了 `copy_options::overwrite_existing`，则将 `from` 解析到的文件的内容和属性复制到 `to` 解析到的文件。
  • 否则，如果 `options` 中设置了 `copy_options::update_existing`，则仅当 `from` 比 `to` 新时才复制文件，由 filesystem::last_write_time() 定义。

非抛出重载在发生错误时返回 false。

目录

[编辑] 参数

from - 源文件的路径
to - 目标文件的路径
ec - 非抛出重载中用于错误报告的出参

[编辑] 返回值

如果文件被复制，则为 true，否则为 false。

[编辑] 异常

任何未标记为 noexcept 的重载都可能在内存分配失败时抛出 std::bad_alloc。

1,3) 在底层操作系统 API 错误时抛出 std::filesystem::filesystem_error，构造时 `from` 作为第一个路径参数，`to` 作为第二个路径参数，操作系统错误码作为错误码参数。
2,4) 如果操作系统 API 调用失败，则将 std::error_code& 参数设置为操作系统 API 错误码；如果未发生错误，则执行 ec.clear()。

[编辑] 注意

这些函数最多包含一次对 filesystem::status(to) 的直接或间接调用（用于确定文件是否存在，以及对于 `filesystem::copy_options::update_existing` 选项，用于其最后写入时间）。

当使用 filesystem::copy_file 复制目录时会报告错误：请使用 filesystem::copy。

filesystem::copy_file 遵循符号链接：请使用 filesystem::copy_symlink 或带 `filesystem::copy_options::copy_symlinks` 的 filesystem::copy。

[编辑] 示例

运行此代码
#include <filesystem>
#include <fstream>
#include <iostream>
namespace fs = std::filesystem;
 
int main()
{
    fs::create_directory("sandbox");
    std::ofstream("sandbox/file1.txt").put('a');
 
    fs::copy_file("sandbox/file1.txt", "sandbox/file2.txt");
 
    // now there are two files in sandbox:
    std::cout << "file1.txt holds: "
              << std::ifstream("sandbox/file1.txt").rdbuf() << '\n';
    std::cout << "file2.txt holds: "
              << std::ifstream("sandbox/file2.txt").rdbuf() << '\n';
 
    // fail to copy directory
    fs::create_directory("sandbox/abc");
    try
    {
        fs::copy_file("sandbox/abc", "sandbox/def");
    }
    catch (fs::filesystem_error& e)
    {
        std::cout << "Could not copy sandbox/abc: " << e.what() << '\n';
    }
    fs::remove_all("sandbox");
}

可能的输出

file1.txt holds: a
file2.txt holds: a
Could not copy sandbox/abc: copy_file: Is a directory: "sandbox/abc", "sandbox/def"

[编辑] 缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 发布时的行为 正确的行为
LWG 3014 C++17 error_code 重载被标记为 noexcept 但可以分配内存 noexcept 已移除

[编辑] 另请参阅

(C++17)
 指定复制操作的语义
(枚举) [编辑]
(C++17)
 复制一个符号链接
(函数) [编辑]
(C++17)
 复制文件或目录
(函数) [编辑]
取自 "https://cppreference.cn/mwiki/index.php?title=cpp/filesystem/copy_file&oldid=157938"