std::filesy...or::options(3)

🎀 std::filesy...or::options(3) 🎀

okay so welcome to the C++ Standard Libary manual, bestie — yes, that spelling is exactly what the page says, and we are not fixing it because archival girlies don't edit the source. This page is all about std::filesystem::recursive_directory_iterator::options, and it's giving "small but important" energy. 💅

✨ NAME ✨

The name is std::filesystem::recursive_directory_iterator::options. And because the original is extra, it says it again: std::filesystem::recursive_directory_iterator::options. That's the whole NAME section, no cap. 👑

🦋 Synopsis 🦋

std::filesystem::directory_options options() const;  (since C++17)

Returns the options that affect the directory iteration — like, the actual settings in play for the iteration. The options can only be supplied when constructing the directory iterator. Constructor time only, bestie; you can't slide them in later. 🫶

If the options argument was not supplied, returns std::filesystem::directory_options::none. That's the default vibe. ✨

💅 Parameters 💅

(none) — literally none. No parameters here, so no "wait, what do I pass?" panic. 🎀

🌈 Return value 🌈

The effective options that affect the directory iteration. That's what you get back: the options actually in effect for the iteration. 💖

🔥 Exceptions 🔥

Throws nothing. Zero. Nada. The exception budget is empty, and it ate. 💀

Source/version shoutout: http://cppreference.com, dated 2024.06.10 — that's the std::filesy...or::options(3) energy, and we're out. 💖🎀🦋