std::experi...ory_iterator(3)

💅 std::experi...ory_iterator(3) 💅

okay so this page is from the C++ Standard Libary (yes, with that spelling, bestie), and it’s all about std::experimental::filesystem::directory_iterator::directory_iterator. It’s giving constructor main-character energy, no cap. 🎀

🎀 NAME 🎀

• std::experimental::filesystem::directory_iterator::directory_iterator — std::experimental::filesystem::directory_iterator::directory_iterator

✨ Synopsis ✨

          directory_iterator();                                      (1)
       (filesystem TS)
          explicit directory_iterator( const path& p );              (2)
       (filesystem TS)
          directory_iterator( const path& p, error_code& ec );       (3)
       (filesystem TS)
          directory_iterator( const directory_iterator& ) = default; (4)
       (filesystem TS)
          directory_iterator( directory_iterator&& ) = default;      (5)
       (filesystem TS)

Constructs a new directory iterator. Literally that. 💫

1. Constructs the end iterator.
2. Constructs a directory iterator that refers to the first directory entry of a directory identified by p. If p refers to a non-existing file or not a directory, returns the end iterator.

bestie, the page only spells out descriptions for (1) and (2) — (3), (4), and (5) are just sitting pretty in the synopsis above. 🙈

🧚 Parameters 🧚

This section is incomplete. That’s it. That’s the whole section. 💀

😭 Exceptions 😭

• (1) — noexcept specification: noexcept
• (2) — filesystem_error if an error occurs. The exception object is constructed with p as an argument.
• (3) — noexcept specification: noexcept

🦋 Notes 🦋

To iterate over the current directory, construct the iterator as directory_iterator(".") instead of directory_iterator(""). This is the little glow-up that matters. ✨

👑 Categories 👑

• Noindexed pages
• Todo without reason
• unconditionally noexcept

💀 Hidden categories 💀

• Pages with unreviewed unconditional noexcept template
• Pages with unreviewed noexcept template

mwah, that’s the whole page! source: http://cppreference.com, version/date: 2024.06.10, and the title for the cheap seats: std::experi...ory_iterator(3). stay iconic, bestie. 💖🫶