std::experimental::filesystem::copy_file
来自cppreference.com
| 在标头 <experimental/filesystem> 定义
|
||
| |
(1) | (文件系统 TS) |
| |
(2) | (文件系统 TS) |
1) 默认情况，等价于 (2) 中以
copy_options::none 用作 options。2) 从
from 复制单个文件为 to，使用 options 所指定的复制选项。如果 options 中给出的任何 copy_options 选项组中有多于一个选项，则其行为未定义（即使与 copy_file 无关的选项组也是如此）。- 如果目标文件不存在，
- 复制
from解析到的文件的内容和属性为to所解析到的文件（跟随符号链接）。
- 复制
- 否则，如果目标文件已经存在：
- 如果
to和from按 equivalent(from, to) 确定为相同，则报告错误。 - 否则，如果
options中未设置任何copy_file控制选项，则报告错误。 - 否则，如果
options中设置了copy_options::skip_existing，则不做任何事。 - 否则，如果
options中设置了copy_options::overwrite_existing，则复制from所解析到的文件的内容和属性给to所解析到的文件。 - 否则，如果
options中设置了copy_options::update_existing，则仅当from比to更新时才复制文件，如 last_write_time() 所定义。
- 如果
当发生错误时，无抛出重载返回 false。
参数
| from | - | 到源文件的路径 |
| to | - | 到目标文件的路径 |
| ec | - | 用于无抛出重载中报告错误的输出形参 |
返回值
如果复制了文件则为 true，否则为 false。
异常
不接受 error_code& 形参的重载，在发生底层 OS API 错误时抛出 filesystem_error，它以 from 为第一实参，以 to 为第二实参，并以 OS 错误码为错误码实参构造。如果内存分配失败，则可抛出 std::bad_alloc。接受 error_code& 形参的重载，当 OS API 调用失败时将之设置为 OS API 错误码，而未发生错误时执行 ec.clear()。此重载具有
noexcept 规定：
noexcept注解
函数涉及至少一次对 status(to) 的直接或间接调用（既用于确定文件是否存在，也用于 copy_options::update_existing 选项时获取最后写入时间）。
当用 copy_file 复制目录时会报错：应当为此使用 copy。
copy_file 会跟随符号链接：应当为此使用 copy_symlink 或以 copy_options::copy_symlinks 调用 copy。
示例
运行此代码
#include <experimental/filesystem>
#include <fstream>
#include <iostream>
namespace fs = std::experimental::filesystem;
int main()
{
fs::create_directory("sandbox");
std::ofstream("sandbox/file1.txt").put('a');
fs::copy_file("sandbox/file1.txt", "sandbox/file2.txt");
// 现在 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';
// 复制目录失败
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"
参阅
| 指定复制操作的语义 (枚举) | |
| 复制一个符号链接 (函数) | |
| 复制文件或目录 (函数) |