std::filesystem::exists

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文件系统库

类
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::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
函数
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::temp_directory_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::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>
bool exists( std::filesystem::file_status s ) noexcept;	(1)	(C++17 起)
bool exists( const std::filesystem::path& p );	(2)	(C++17 起)
bool exists( const std::filesystem::path& p, std::error_code& ec ) noexcept;	(3)	(C++17 起)

检查给定文件状态或路径是否对应于现有文件或目录。

1) 等价于 status_known(s) && s.type() != file_type::not_found。

2,3) 令 s 为一个 std::filesystem::file_status，其确定方式分别如同 status(p) 或 status(p, ec)（符号链接被跟踪）。返回 exists(s)。如果 status_known(s)，非抛出重载会调用 ec.clear()。

参数

s	-	要检查的文件状态
p	-	要检查的路径
ec	-	非抛出重载中用于错误报告的出参

返回值

如果给定路径或文件状态对应于现有文件或目录，则为 true，否则为 false。

异常

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

2) 在底层 OS API 错误时抛出 std::filesystem::filesystem_error，构造时以 p 作为第一个路径参数，OS 错误码作为错误码参数。

3) 如果 OS API 调用失败，将 std::error_code& 参数设置为 OS API 错误码；如果没有发生错误，则执行 ec.clear()。

如果对象不存在（使用返回值），则不抛出任何文件系统异常。

注意

此函数提供的信息通常也作为目录迭代的副产品提供。在目录迭代期间，调用 exists(*iterator) 的效率低于 exists(iterator->status())。

示例

运行此代码

#include <cstdint>
#include <filesystem>
#include <fstream>
#include <iostream>
namespace fs = std::filesystem;
 
void demo_exists(const fs::path& p, fs::file_status s = fs::file_status{})
{
    std::cout << p;
    if (fs::status_known(s) ? fs::exists(s) : fs::exists(p))
        std::cout << " exists\n";
    else
        std::cout << " does not exist\n";
}
 
int main()
{
    const fs::path sandbox{"sandbox"};
    fs::create_directory(sandbox);
    std::ofstream{sandbox/"file"}; // create regular file
    fs::create_symlink("non-existing", sandbox/"symlink");
 
    demo_exists(sandbox);
 
    for (const auto& entry : fs::directory_iterator(sandbox))
        demo_exists(entry, entry.status()); // use cached status from directory entry
 
    fs::remove_all(sandbox);
}

输出

"sandbox" exists
"sandbox/symlink" does not exist
"sandbox/file" exists

参阅

statussymlink_status (C++17)(C++17)	确定文件属性 确定文件属性，检查符号链接目标 (函数)
file_status (C++17)	表示文件类型和权限 (类)
exists	检查目录项是否引用现有文件系统对象 (std::filesystem::directory_entry 的公开成员函数)