文件系统库 (C++17 起)
来自 cppreference.cn
< cpp
文件系统库提供对文件系统及其组件(例如路径、常规文件和目录)执行操作的功能。
文件系统库最初是作为 boost.filesystem 开发的,作为 技术规范 ISO/IEC TS 18822:2015 发布,并最终于 C++17 合并到 ISO C++。Boost 实现目前在比 C++17 库更多的编译器和平台上可用。
如果实现无法访问分层文件系统,或者它不提供必要的功能,则文件系统库功能可能不可用。如果底层文件系统不支持某些功能(例如,FAT 文件系统缺少符号链接并禁止多个硬链接),则这些功能可能不可用。在这些情况下,必须报告错误。
如果对该库中函数的调用引入了“文件系统竞争”,即当多个线程、进程或计算机交错访问和修改文件系统中的同一对象时,则行为是未定义的。
目录 |
[编辑] 库范围定义
- 文件:一个文件系统对象,它包含数据,可以写入、读取或两者兼有。文件有名称、属性,其中一个属性是文件类型。
- 目录:一个文件,充当目录条目的容器,这些条目标识其他文件(其中一些可能是其他嵌套目录)。讨论特定文件时,它作为条目出现的目录是它的父目录。父目录可以用相对路径名 ".." 表示。
- 常规文件:一个将名称与现有文件关联的目录条目(即硬链接)。如果支持多个硬链接,则在删除最后一个硬链接后删除该文件。
- 符号链接:一个将名称与路径关联的目录条目,该路径可能存在也可能不存在。
- 其他特殊文件类型:块、字符、FIFO、套接字。
- 文件名:一个命名文件的字符串。允许的字符、大小写敏感性、最大长度以及不允许的名称是实现定义的。名称 "."(点)和 ".."(点点)在库级别具有特殊含义。
- 路径:标识文件的一系列元素。它以可选的 root-name(例如 Windows 上的 "C:" 或 "//server")开头,后跟可选的 root-directory(例如 Unix 上的 "/"),再后跟零个或多个文件名的序列(除了最后一个文件名,所有文件名都必须是目录或指向目录的链接)。路径的字符串表示(路径名)的本地格式(例如用作分隔符的字符)和字符编码是实现定义的,此库提供路径的可移植表示。
- 绝对路径:明确标识文件位置的路径。
- 规范路径:不包含符号链接、"." 或 ".." 元素的绝对路径。
- 相对路径:相对于文件系统上某个位置标识文件位置的路径。特殊路径名 "."(点,“当前目录”)和 ".."(点点,“父目录”)是相对路径。
类 | |
定义于头文件
<filesystem> | |
定义于命名空间
std::filesystem | |
(C++17) |
表示一个路径 (类) |
(C++17) |
文件系统错误时抛出的异常 (类) |
(C++17) |
目录项 (类) |
(C++17) |
指向目录内容的迭代器 (类) |
(C++17) |
指向目录及其子目录内容的迭代器 (类) |
(C++17) |
表示文件类型和权限 (类) |
(C++17) |
关于文件系统空闲和可用空间的信息 (类) |
(C++17) |
文件类型 (枚举) |
(C++17) |
标识文件系统权限 (枚举) |
(C++17) |
指定权限操作的语义 (枚举) |
(C++17) |
指定复制操作的语义 (枚举) |
(C++17) |
迭代目录内容的选项 (枚举) |
(C++17) |
表示文件时间值 (typedef) |
非成员函数 | |
定义于头文件
<filesystem> | |
定义于命名空间
std::filesystem | |
(C++17) |
组成一个绝对路径 (函数) |
(C++17) |
组成一个规范路径 (函数) |
(C++17) |
组成一个相对路径 (函数) |
(C++17) |
复制文件或目录 (函数) |
(C++17) |
复制文件内容 (函数) |
(C++17) |
复制一个符号链接 (函数) |
(C++17)(C++17) |
创建新目录 (函数) |
(C++17) |
创建硬链接 (函数) |
(C++17)(C++17) |
创建符号链接 (函数) |
(C++17) |
返回或设置当前工作目录 (函数) |
(C++17) |
检查路径是否引用现有文件系统对象 (函数) |
(C++17) |
检查两个路径是否引用相同的文件系统对象 (函数) |
(C++17) |
返回文件大小 (函数) |
(C++17) |
返回引用特定文件的硬链接数量 (函数) |
(C++17) |
获取或设置最后数据修改时间 (函数) |
(C++17) |
修改文件访问权限 (函数) |
(C++17) |
获取符号链接的目标 (函数) |
(C++17)(C++17) |
删除文件或空目录 删除文件或目录及其所有内容,递归进行 (函数) |
(C++17) |
移动或重命名文件或目录 (函数) |
(C++17) |
通过截断或零填充更改常规文件的大小 (函数) |
(C++17) |
确定文件系统上可用的空闲空间 (函数) |
(C++17)(C++17) |
确定文件属性 确定文件属性,检查符号链接目标 (函数) |
(C++17) |
返回适合临时文件的目录 (函数) |
文件类型 | |
(C++17) |
检查给定路径是否引用块设备 (函数) |
(C++17) |
检查给定路径是否引用字符设备 (函数) |
(C++17) |
检查给定路径是否引用目录 (函数) |
(C++17) |
检查给定路径是否引用空文件或目录 (函数) |
(C++17) |
检查给定路径是否引用命名管道 (函数) |
(C++17) |
检查参数是否引用“其他”文件 (函数) |
(C++17) |
检查参数是否引用常规文件 (函数) |
(C++17) |
检查参数是否引用命名 IPC 套接字 (函数) |
(C++17) |
检查参数是否引用符号链接 (函数) |
(C++17) |
检查文件状态是否已知 (函数) |
[编辑] 注意
使用此库可能需要额外的编译器/链接器选项。9.1 之前的 GNU 实现需要链接 -lstdc++fs
,LLVM 9.0 之前的 LLVM 实现需要链接 -lc++fs
。
特性测试宏 | 值 | 标准 | 特性 |
---|---|---|---|
__cpp_lib_filesystem |
201703L |
(C++17) | 文件系统库 |
[编辑] 另请参见
C++ 文档 用于 File System TS
|