std::filesyste...ectory_iterator(3cxx)

okay so bestie, welcome to the std::filesyste...ectory_iterator(3cxx) page — that’s the 3cxx manual section — and it is literally all about std::filesystem::recursive_directory_iterator. This iterator is your main character for walking a directory hierarchy recursively. No cap. 💅✨

---

💌 NAME 💌

std::filesystem::recursive_directory_iterator — Iterator type for recursively traversing a directory hierarchy. That’s the name, that’s the vibe, and yes it’s giving recursive directory traversal energy. 🦋

✨ SYNOPSIS ✨

#include <filesystem>

That’s the include, periodt. 💖

🌈 Public Types 🌈

Here are the exact typedefs, bestie — every single one is iconic:

• typedef ptrdiff_t difference_type — the difference type, slay. 🎀
• typedef input_iterator_tag iterator_category — input iterator category, noted. 🌸
• typedef const directory_entry * pointer — pointer type, exactly as written. 🦋
• typedef const directory_entry & reference — reference type, exactly as written. 💅
• typedef directory_entry value_type — value type, exactly as written. ⭐

🎀 Public Member Functions 🎀

Every signature, no skips, no cap:

• recursive_directory_iterator (const path &__p) — constructor taking const path &__p. 💖
• recursive_directory_iterator (const path &__p, directory_options __options) — constructor taking const path &__p and directory_options __options. ✨
• recursive_directory_iterator (const path &__p, directory_options __options, error_code &__ec) — constructor taking const path &__p, directory_options __options, and error_code &__ec. 🎀
• recursive_directory_iterator (const path &__p, error_code &__ec) — constructor taking const path &__p and error_code &__ec. 🦋
• recursive_directory_iterator (const recursive_directory_iterator &)=default — copy constructor, defaulted. 💅
• recursive_directory_iterator (recursive_directory_iterator &&)=default — move constructor, defaulted. 🌸
• int depth () const noexcept — the depth member returns int, and it’s noexcept. ⭐
• void disable_recursion_pending () noexcept — the disable_recursion_pending member, and it’s noexcept. 🫶
• recursive_directory_iterator & increment (error_code &__ec) — increment taking error_code &__ec. 🔥
• const directory_entry & operator* () const noexcept — dereference operator returning const directory_entry &, noexcept. 👑
• recursive_directory_iterator & operator++ () — prefix operator++, returns a reference. 🌈
• __directory_iterator_proxy operator++ (int) — postfix operator++ taking int, returns __directory_iterator_proxy. ⭐
• const directory_entry * operator-> () const noexcept — arrow operator returning const directory_entry *, noexcept. 💀
• recursive_directory_iterator & operator= (const recursive_directory_iterator &__rhs) noexcept — copy assignment from const recursive_directory_iterator &__rhs, noexcept. 🙈
• recursive_directory_iterator & operator= (recursive_directory_iterator &&__rhs) noexcept — move assignment from recursive_directory_iterator &&__rhs, noexcept. 🍓
• bool operator== (default_sentinel_t) const noexcept — equality against default_sentinel_t, returns bool, noexcept. 🧚
• directory_options options () const noexcept — the options member returns directory_options, noexcept. 💜
• void pop () — pop, no arguments. 🎀
• void pop (error_code &) — pop taking error_code &. 🦋
• bool recursion_pending () const noexcept — recursion_pending returns bool, noexcept. 💖

🫶 Friends 🫶

These are the friend functions, exactly as listed:

• uintmax_t filesystem::remove_all (const path &) — friend remove_all taking const path &, returns uintmax_t. ✨
• uintmax_t filesystem::remove_all (const path &, error_code &) — friend remove_all taking const path & and error_code &, returns uintmax_t. 🌸
• bool operator== (const recursive_directory_iterator &__lhs, const recursive_directory_iterator &__rhs) noexcept — friend equality comparing two iterators, returns bool, noexcept. 💅

🔥 Detailed Description 🔥

std::filesystem::recursive_directory_iterator is an iterator type for recursively traversing a directory hierarchy. That’s the detailed description and it ate. 🔥

⭐ Since ⭐

C++17 — since C++17, bestie. This one is giving modern C++ energy. 👑

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. So Doxygen wrote it, not a human, but we still dressed it up cute. 💖

---

mwah 💋 — sourced from libstdc++ (the source/version footer tag is libstdstd::filesyste...ectory_iterator(3cxx)), and no separate date is listed on this page. bye bestie, go traverse recursively! 🫶✨