std::experimental::filesystem::recursive_directory_iterator

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

實驗性

技術規範

檔案系統庫 (檔案系統 TS)

庫基礎 (庫基礎 TS)

庫基礎 2 (庫基礎 TS v2)

庫基礎 3 (庫基礎 TS v3)

並行性擴充套件 (並行性 TS)

並行性擴充套件 2 (並行性 TS v2)

併發性擴充套件 (併發性 TS)

併發擴充套件 2 (concurrency TS v2)

概念 (概念 TS)

範圍 (範圍 TS)

反射 (反射 TS)

數學特殊函式 (特殊函式 TR)

實驗性非 TS

模式匹配

線性代數

std::execution

契約

2D 圖形

 

檔案系統庫

類
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::copy_options filesystem::directory_options filesystem::file_time_type
函式
filesystem::absolute filesystem::system_complete filesystem::canonical 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

 

recursive_directory_iterator

成員函式

recursive_directory_iterator::recursive_directory_iterator

recursive_directory_iterator::operator*recursive_directory_iterator::operator->

recursive_directory_iterator::options

recursive_directory_iterator::depth

recursive_directory_iterator::recursion_pending

recursive_directory_iterator::operator=

recursive_directory_iterator::incrementrecursive_directory_iterator::operator++

recursive_directory_iterator::pop

recursive_directory_iterator::disable_recursion_pending

非成員函式

begin(recursive_directory_iterator)end(recursive_directory_iterator)

 

定義於標頭檔案 <experimental/filesystem>
class recursive_directory_iterator;		(filesystem TS)

recursive_directory_iterator 是一個 LegacyInputIterator，它迭代目錄的 directory_entry 元素，並遞迴迭代所有子目錄的條目。迭代順序未指定，除了每個目錄條目只訪問一次。

預設情況下，不跟隨符號連結，但這可以透過在構造時指定目錄選項 follow_directory_symlink 來啟用。

特殊路徑名 dot 和 dot-dot 會被跳過。

如果 recursive_directory_iterator 超越頂層目錄的最後一個目錄條目，它將變得與預設構造的迭代器（也稱為結束迭代器）相等。兩個結束迭代器總是相等，解引用或遞增結束迭代器是未定義行為。

如果在建立遞迴目錄迭代器後，檔案或目錄被刪除或新增到目錄樹中，則透過迭代器是否觀察到此更改是未指定的。

如果目錄結構包含迴圈，則可能無法到達結束迭代器。

成員型別

成員型別	定義
value_type	filesystem::directory_entry
difference_type	std::ptrdiff_t
pointer	const filesystem::directory_entry*
reference	const filesystem::directory_entry&
iterator_category	std::input_iterator_tag

成員函式

(建構函式)	構造一個遞迴目錄迭代器 (public member function)
(解構函式)	預設解構函式 (public member function)
觀察器
operator*operator->	訪問指向的條目 (public member function)
options	返回當前活躍的影響迭代的選項 (public member function)
depth	返回當前遞迴深度 (public member function)
recursion_pending	檢查當前目錄是否停用遞迴 (public member function)
修改器
operator=	賦值內容 (public member function)
incrementoperator++	前進到下一個條目 (public member function)
pop	在目錄層次結構中將迭代器向上移動一級 (public member function)
disable_recursion_pending	停用遞迴直到下一次遞增 (public member function)

非成員函式

filesystem::begin(filesystem::recursive_directory_iterator)filesystem::end(filesystem::recursive_directory_iterator)

支援基於範圍的 for 迴圈 (function)

此外，根據 LegacyInputIterator 的要求，提供了 operator== 和 operator!=，作為成員函式或非成員函式。

注意

recursive_directory_iterator 通常持有一個引用計數的指標（以滿足 LegacyInputIterator 的淺複製語義）到一個實現物件，該物件持有

• 一個非遞迴 directory_iterators 的容器（例如 std::vector），它構成了遞迴棧。
• 遞迴深度計數器（可透過 depth() 訪問）。
• 構造時使用的目錄選項（可透過 options() 訪問）。
• 待定遞迴標誌（可透過 recursion_pending() 訪問，可與目錄選項結合以節省空間）。

示例

執行此程式碼

#include <experimental/filesystem>
#include <fstream>
#include <iostream>
namespace fs = std::experimental::filesystem;
 
int main()
{
    fs::create_directories("sandbox/a/b");
    std::ofstream("sandbox/file1.txt");
    fs::create_symlink("a", "sandbox/syma");
    for (const fs::directory_entry& entry : fs::recursive_directory_iterator("sandbox"))
        std::cout << entry << '\n';
    fs::remove_all("sandbox");
}

可能的輸出

"sandbox/a"
"sandbox/a/b"
"sandbox/file1.txt"
"sandbox/syma"

另請參見

directory_iterator	指向目錄內容的迭代器 (class)
directory_entry	目錄項 (class)
directory_options	迭代目錄內容的選項 (enum)