STD::FILESYSTEM::DIRECTORY_ITERATOR(3)

💖 std::filesystem::directory_iterator 💖

okay bestie, welcome to the <filesystem> manual — specifically the page for std::filesystem::directory_iterator, a libstdc++ Library Functions Manual situation. this one is the iterator type for traversing the entries in a single directory, and she is lowkey iconic. no cap.

---

✨ NAME ✨

std::filesystem::directory_iterator — iterator type for traversing the entries in a single directory. that's it, that's the whole vibe. one directory, one iterator, slay. 💅

---

🌸 SYNOPSIS 🌸

#include <filesystem>

🦋 Public Types

• typedef ptrdiff_t difference_type — the difference type, standard-issue.
• typedef input_iterator_tag iterator_category — she's an input iterator, periodt.
• typedef const directory_entry * pointer — pointer to a const directory_entry.
• typedef const directory_entry & reference — reference to a const directory_entry.
• typedef directory_entry value_type — the value type is directory_entry, obviously.

🎀 Public Member Functions

• directory_iterator (const directory_iterator &__rhs)=default — copy constructor, defaulted, no notes.
• directory_iterator (const path &__p) — construct one for the path __p.
• directory_iterator (const path &__p, directory_options __options) — same but you also get to pass __options.
• directory_iterator (const path &__p, directory_options __options, error_code &__ec) — path, options, and an error_code to catch what went wrong.
• directory_iterator (const path &__p, error_code &__ec) — path plus an error_code.
• directory_iterator (directory_iterator &&__rhs) noexcept=default — move constructor, defaulted, noexcept, she moves fast fr fr.
• directory_iterator & increment (error_code &__ec) — advance it, reporting into __ec.
• const directory_entry & operator* () const noexcept — dereference, get your directory_entry. noexcept, we love that.
• directory_iterator & operator++ () — pre-increment. step to the next entry bestie.
• __directory_iterator_proxy operator++ (int) — post-increment, returns the mysterious __directory_iterator_proxy.
• const directory_entry * operator-> () const noexcept — arrow operator, noexcept, gives you the pointer.
• directory_iterator & operator= (const directory_iterator &__rhs)=default — copy assignment, defaulted.
• directory_iterator & operator= (directory_iterator &&__rhs) noexcept=default — move assignment, defaulted and noexcept.
• bool operator== (default_sentinel_t) const noexcept — comparison against default_sentinel_t, noexcept. this is how you know you hit the end. 🛑

💜 Friends

• bool operator== (const directory_iterator &__lhs, const directory_iterator &__rhs) noexcept — comparing two iterators, noexcept.
• class recursive_directory_iterator — she's a friend of the house.

🌈 Related Symbols

heads up bestie: these are not member symbols. they just live nearby.

• directory_iterator begin (directory_iterator __iter) noexcept — enable range-based for using directory_iterator.
• directory_iterator end (directory_iterator) noexcept — return a past-the-end directory_iterator.
• recursive_directory_iterator begin (recursive_directory_iterator __iter) noexcept — enable range-based for using recursive_directory_iterator.
• recursive_directory_iterator end (recursive_directory_iterator) noexcept — return a past-the-end recursive_directory_iterator.

---

🧚 Detailed Description

Iterator type for traversing the entries in a single directory. she does one job and she does it gorgeously. 💖

Since: C++17 — yes she's been here since C++17, an elder stateswoman, a queen. 👑

---

👑 Author

Generated automatically by Doxygen for libstdc++ from the source code. not me writing a whole personality for an auto-generated doc 💀

---

so yeah, that's the whole page. every type, every constructor, every operator, every friend, every related symbol — all accounted for. ate and left no crumbs ✨

sign-off time: this was the libstdc++ manual page for std::filesystem::directory_iterator, brought to you by libstdc++ (and Doxygen, who technically wrote all of it). mwah 💋 🫶