std::filesystem::path::iterator(3cxx)

💖 NAME 💖

okay so this is std::filesystem::path::iterator from the 3cxx manual, and it’s literally an iterator for the components of a path. That’s the whole name vibe, bestie — no cap. 🦋

✨ SYNOPSIS ✨

#include <filesystem>

🎀 Public Types 🎀

• using difference_type = std::ptrdiff_t — the difference type, periodt.
• using iterator_category = std::bidirectional_iterator_tag — its iterator category is literally std::bidirectional_iterator_tag.
• using pointer = const path * — pointer type is const path *.
• using reference = const path & — reference type is const path &.
• using value_type = path — value type is path.

🫶 Public Member Functions 🫶

• iterator (const iterator &)=default — copy constructor, defaulted.
• reference operator* () const noexcept — dereference operator, noexcept.
• iterator & operator++ () noexcept — pre-increment, returns iterator &, noexcept.
• iterator operator++ (int) noexcept — post-increment, returns iterator, noexcept.
• iterator & operator-- () noexcept — pre-decrement, returns iterator &, noexcept.
• iterator operator-- (int) noexcept — post-decrement, returns iterator, noexcept.
• pointer operator-> () const noexcept — arrow operator, noexcept.
• iterator & operator= (const iterator &)=default — copy assignment, defaulted.

🦋 Friends 🦋

• void __path_iter_advance (iterator &__i, difference_type __n) noexcept — friend helper named __path_iter_advance, noexcept.
• difference_type __path_iter_distance (const iterator &__first, const iterator &__last) noexcept — friend helper named __path_iter_distance, noexcept.
• bool operator!= (const iterator &__lhs, const iterator &__rhs) noexcept — not-equal comparison friend, noexcept.
• bool operator== (const iterator &__lhs, const iterator &__rhs) noexcept — equal comparison friend, noexcept.
• class path — path is a friend class.

🌸 Detailed Description 🌸

okay bestie, the detailed description is honestly iconic in its brevity:

An iterator for the components of a path.

⭐ Since ⭐

C++17. literally since C++17. ✨

👑 Author 👑

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

---

okay bye bestie 💖 — footer deets: source/version libstdc is chillin’ with std::filesystem::path::iterator(3cxx) in the footer, and no date is printed there, so I’m not inventing one, periodt. slay responsibly 🫶