std::filesystem::copy_options

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

文件系统库

类
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::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options filesystem::file_time_type
函数
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::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::temp_directory_path
文件类型
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>
enum class copy_options {     none = /* unspecified */,     skip_existing = /* unspecified */,     overwrite_existing = /* unspecified */,     update_existing = /* unspecified */,     recursive = /* unspecified */,     copy_symlinks = /* unspecified */,     skip_symlinks = /* unspecified */,     directories_only = /* unspecified */,     create_symlinks = /* unspecified */,     create_hard_links = /* unspecified */ };		(C++17 起)

此类型代表控制 copy() 及 copy_file() 函数行为的可用选项。

copy_options 满足位掩码类型 (BitmaskType) 的要求（表示位运算符 operator& 、 operator| 、 operator^ 、 operator~ 、 operator&= 、 operator|= 及 operator^= 对此类型定义）。 none 代表空位掩码；每个其他枚举项都代表有别的位掩码元素。

成员常量

每个下列选项组中至多存在一个选项，否则复制函数的行为未定义。

成员常量	含义
文件已存在时控制 copy_file() 的选项
none	报告错误（默认行为）
skip_existing	保持既存文件，而不报告错误。
overwrite_existing	替换既存文件。
update_existing	替换既存文件，仅若它旧于被复制的文件
在子目录上控制 copy() 效果的选项
none	跳过子目录（默认行为）
recursive	递归地复制子目录及其内容
在符号链接上控制 copy() 效果的选项
none	跟随符号链接（默认行为）
copy_symlinks	复制符号链接为符号链接，而非其所指的文件
skip_symlinks	忽略符号链接
控制 copy() 所做的复制类型的选项
none	复制文件内容（默认行为）
directories_only	复制目录结构，但不复制任何非目录文件
create_symlinks	创建指向原有文件的符号链接，而不创建文件副本。注意：源路径必须是绝对路径，除非目标路径在当前目录中。
create_hard_links	创建解析到与原有文件相同文件的硬链接，而不创建文件副本

示例

运行此代码

#include <cstdlib>
#include <iostream>
#include <fstream>
#include <filesystem>
namespace fs = std::filesystem;
 
int main()
{
    fs::create_directories("sandbox/dir/subdir");
    std::ofstream("sandbox/file1.txt").put('a');
    fs::copy("sandbox/file1.txt", "sandbox/file2.txt"); // 复制文件
    fs::copy("sandbox/dir", "sandbox/dir2"); // 复制目录（非递归）
    const auto copyOptions = fs::copy_options::update_existing
                           | fs::copy_options::recursive
                           | fs::copy_options::directories_only
                           ;
    fs::copy("sandbox", "sandbox_copy", copyOptions); 
    static_cast<void>(std::system("tree"));
    fs::remove_all("sandbox");
    fs::remove_all("sandbox_copy");
}

可能的输出：

.
├── sandbox
│   ├── dir
│   │   └── subdir
│   ├── dir2
│   ├── file1.txt
│   └── file2.txt
└── sandbox_copy
    ├── dir
    │   └── subdir
    └── dir2
 
8 directories, 2 files

参阅

copy (C++17)	复制文件或目录 (函数)
copy_file (C++17)	复制文件内容 (函数)