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

💅 std::filesystem::directory_iterator

okay bestie, welcome to the std::filesyste...ectory_iterator(3cxx) manual page. today’s main character is std::filesystem::directory_iterator, and we are keeping every signature, default, noexcept, friend, and reference exactly as written. no cap, no cuts ✨

---

🌸 NAME

std::filesystem::directory_iterator — iterator type for traversing the entries in a single directory. periodt. 💅

✨ SYNOPSIS

#include <filesystem>

🎀 Public Types

the whole type cast, no skips:

• typedef ptrdiff_t difference_type
• typedef input_iterator_tag iterator_category
• typedef const directory_entry * pointer
• typedef const directory_entry & reference
• typedef directory_entry value_type

🦋 Public Member Functions

every single public member function, in the order the page gives them:

• directory_iterator (const directory_iterator &__rhs)=default
• directory_iterator (const path &__p)
• directory_iterator (const path &__p, directory_options __options)
• directory_iterator (const path &__p, directory_options __options, error_code &__ec)
• directory_iterator (const path &__p, error_code &__ec)
• directory_iterator (directory_iterator &&__rhs) noexcept=default
• directory_iterator & increment (error_code &__ec)
• const directory_entry & operator* () const noexcept
• directory_iterator & operator++ ()
• __directory_iterator_proxy operator++ (int)
• const directory_entry * operator-> () const noexcept
• directory_iterator & operator= (const directory_iterator &__rhs)=default
• directory_iterator & operator= (directory_iterator &&__rhs) noexcept=default
• bool operator== (default_sentinel_t) const noexcept

💖 Friends

the friend squad, exactly as listed:

• friend equality — exact wrapped signature:

bool operator== (const directory_iterator &__lhs, const
         directory_iterator &__rhs) noexcept

• friend class — class recursive_directory_iterator

🌈 Related Symbols

quick note, bestie: (Note that these are not member symbols.)

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

🔥 Detailed Description

the detailed description is literally: “Iterator type for traversing the entries in a single directory.” that’s the vibe, and we’re not adding extra lore. 🫶

⭐ Since

C++17 — iconic, honestly.

👑 Author

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

---

okay that’s the whole page, bestie. the final footer/source line is exactly libstdstd::filesyste...ectory_iterator(3cxx) — and that’s the date-stamp energy we have, mwah 💋✨