std::experi...ory_iterator(3)

💅 NAME

std::experimental::filesystem::recursive_directory_iterator::recursive_directory_iterator — okay so it's the constructor of that whole mouthful, and yes, the man page literally says the giant qualified name twice, so I'm telling you twice too. No cap. It's the filesystem TS version, bestie, don't come for me.

This is the C++ Standard Library manual, section 3, and we're deep in constructor territory.

---

🦋 SYNOPSIS

recursive_directory_iterator();                                  (1)
(filesystem TS)
recursive_directory_iterator( const                              (2)
(filesystem TS)
recursive_directory_iterator& ) = default;
recursive_directory_iterator( recursive_directory_iterator&& ) = (3)
(filesystem TS)
default;
explicit recursive_directory_iterator( const path& p,
                                       directory_options options (4)
(filesystem TS)
= directory_options::none );
recursive_directory_iterator( const path& p,
                              directory_options options,         (5)
(filesystem TS)
error_code& ec );
recursive_directory_iterator( const path& p, error_code& ec );   (6)
(filesystem TS)

Constructs a new recursive directory iterator. That's the whole vibe. ✨

1. Default constructor. Constructs an end iterator. Iconic, empty, done.
2. , 3. Default copy and move constructors. They just do what they say on the tin, = default and all.
4. –6. Constructs an iterator that refers to the first entry in the directory that p resolves to. Look at it go 🫶

⚠️ Incomplete section alert! The original page literally says "This section is incomplete" with the reason "errors". So like… nobody fully wrote this part yet. Not me making that up, fr fr.

---

🌸 PARAMETERS

This section is incomplete. That's it. That's the parameter section. The page really does leave us hanging like that 😭 The path& p, directory_options options, and error_code& ec from the synopsis are all we get.

---

💀 EXCEPTIONS

Overloads 1, 5, and 6 have a noexcept specification of:

noexcept

⚠️ Another "This section is incomplete" lives right here too. The docs are under construction, what can I say 🙈

---

🧚 NOTES

Recursive directory iterators do not follow directory symlinks by default. Periodt. To enable this behavior, specify directory_options::follow_directory_symlink among the options option set. That's your glow-up for symlink-chasing energy 🔥

---

👑 CATEGORIES

The page is filed under these, and yes, we're listing every single one:

• Noindexed pages
• Todo with reason
• Todo without reason
• unconditionally noexcept

🌈 Hidden categories

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

---

✨ That's the whole page, bestie ✨ It came from http://cppreference.com, timestamped 2024.06.10 — bookmark it, cite it, live by it 💖