STD::FILESYSTEM_RECURSIVE_DIRECTORY_ITERATOR(3)

💖 NAME

std::filesystem::recursive_directory_iterator — the iterator type for recursively traversing a directory hierarchy, bestie. This is the std::filesystem::recursive_directory_iterator(3) page from the Library Functions Manual, and yes, we're gonna get through every single signature together. 🫶

---

✨ SYNOPSIS ✨

🌸 Public Types

• typedef ptrdiff_t difference_type — the difference type. Slay.
• typedef input_iterator_tag iterator_category — the iterator category is input_iterator_tag.
• typedef const directory_entry * pointer — pointer type: const directory_entry *.
• typedef const directory_entry & reference — reference type: const directory_entry &.
• typedef directory_entry value_type — value type: directory_entry.

🎀 Public Member Functions

• recursive_directory_iterator (const path &__p) — constructor that takes const path &__p.
• recursive_directory_iterator (const path &__p, directory_options __options) — constructor that takes const path &__p and directory_options __options.
• recursive_directory_iterator (const path &__p, directory_options __options, error_code &__ec) — constructor that takes const path &__p, directory_options __options, and error_code &__ec.
• recursive_directory_iterator (const path &__p, error_code &__ec) — constructor that takes const path &__p and error_code &__ec.
• recursive_directory_iterator (const recursive_directory_iterator &)=default — defaulted copy constructor. Iconic behavior.
• recursive_directory_iterator (recursive_directory_iterator &&)=default — defaulted move constructor. Also iconic.
• int depth () const noexcept — returns int, and it's marked const noexcept.
• void disable_recursion_pending () noexcept — returns void, marked noexcept.
• recursive_directory_iterator & increment (error_code &__ec) — takes error_code &__ec and returns recursive_directory_iterator &.
• const directory_entry & operator* () const noexcept — returns const directory_entry &, marked const noexcept.
• recursive_directory_iterator & operator++ () — returns recursive_directory_iterator &.
• __directory_iterator_proxy operator++ (int) — returns __directory_iterator_proxy.
• const directory_entry * operator-> () const noexcept — returns const directory_entry *, marked const noexcept.
• recursive_directory_iterator & operator= (const recursive_directory_iterator &__rhs) noexcept — copy assignment, takes const recursive_directory_iterator &__rhs, returns recursive_directory_iterator &, marked noexcept.
• recursive_directory_iterator & operator= (recursive_directory_iterator &&__rhs) noexcept — move assignment, takes recursive_directory_iterator &&__rhs, returns recursive_directory_iterator &, marked noexcept.
• directory_options options () const noexcept — returns directory_options, marked const noexcept.
• void pop () — returns void, no arguments.
• void pop (error_code &) — returns void, takes error_code &.
• bool recursion_pending () const noexcept — returns bool, marked const noexcept.

🦋 Friends

• uintmax_t filesystem::remove_all (const path &) — friend function with this exact signature.
• uintmax_t filesystem::remove_all (const path &, error_code &) — friend function with this exact signature.
• bool operator!= (const recursive_directory_iterator &__lhs, const recursive_directory_iterator &__rhs) noexcept — friend comparison, marked noexcept.
• bool operator== (const recursive_directory_iterator &__lhs, const recursive_directory_iterator &__rhs) noexcept — friend comparison, marked noexcept.

🌈 Related Functions

Heads up, bestie: these are not member functions. They're related functions, and here's every detail.

• recursive_directory_iterator begin (recursive_directory_iterator __iter) noexcept — enables range-based for using recursive_directory_iterator. Marked noexcept.
• recursive_directory_iterator end (recursive_directory_iterator) noexcept — returns a past-the-end recursive_directory_iterator. Marked noexcept.

---

👑 Detailed Description

Iterator type for recursively traversing a directory hierarchy. That's the whole vibe: recursive directory traversal iterator energy. 💅

---

💜 Author

Generated automatically by Doxygen for libstdc++ from the source code.

Cute little sign-off time: source/version is libstdc++, and the date is Wed Oct 7 2026. Byeee, bestie — go traverse those directories recursively and safely. 🦋✨🎀