std::filesy...::operator*,(3)

💖 NAME 💖

This is the std::filesy...::operator*,(3) page from the C++ Standard Libary manual, bestie — yes, the typo is in the manual name, not you. The NAME section is literally about std::filesystem::directory_iterator::operator*,, and the raw NAME lines are std::filesystem::directory_iterator::operator*, - and std::filesystem::directory_iterator::operator*,. Slay. ✨

🌸 Synopsis 🌸

const std::filesystem::directory_entry& operator*() const;  (1)
(since C++17)
const std::filesystem::directory_entry* operator->() const; (2)
(since C++17)

Both of these access the pointed-to directory_entry. The result of operator* or operator-> on the end iterator is undefined behavior — like, do not, fr fr 😭💀.

🎀 Parameters 🎀

(none) — no parameters at all. Zero. Nada. 🫶

⭐ Return value ⭐

1. Value of the directory_entry referred to by this iterator.
2. Pointer to the directory_entry referred to by this iterator.

🔥 Exceptions 🔥

May throw implementation-defined exceptions. That's the tea. ☕

👑 See also 👑

• operator* — accesses the pointed-to entry
• operator-> — (public member function of std::filesystem::recursive_directory_iterator)

xoxo, your Unix bestie 💅 — source: http://cppreference.com, version/date: 2024.06.10, page: std::filesy...::operator*,(3). Bye bestie! 💖✨