std::filesy...ory_options(3)

💖 std::filesystem::directory_options 💖

okay bestie, so this is std::filesystem::directory_options from the C++ Standard Library (the cppreference girlies run this one) and honestly? it's giving "tiny enum, huge power." it's the little options menu that tells your directory iterators how to behave. no cap. 🦋

---

✨ Synopsis ✨

first things first, she lives here:

Defined in header <filesystem>

and here's literally the whole shape of her:

enum class directory_options {

    none = /* unspecified */,
    follow_directory_symlink = /* unspecified */,  (since C++17)
    skip_permission_denied = /* unspecified */

};

so what is this? this type represents the available options that control the behavior of the directory_iterator and the recursive_directory_iterator. that's her whole job. 🎀

and listen — directory_options satisfies the requirements of BitmaskType, which means the bitwise operators operator&, operator|, operator^, operator~, operator&=, operator|=, and operator^= are all defined for this type. every single one. slay. ✨

none represents the empty bitmask, and every other enumerator represents a distinct bitmask element. periodt. 💅

---

👑 Member constants 👑

here's the lineup, main character energy only:

• none — the default. skips directory symlinks, and permission denied is an error. 🙈
• follow_directory_symlink — follows directory symlinks instead of skipping them. she's curious like that. 🦋
• skip_permission_denied — skips directories that would otherwise result in permission denied errors. avoiding the drama, iconic. 💀

---

🌸 Example 🌸

big mood: this section is incomplete.

Reason: no example

(it's giving "we'll do it later" and honestly, relatable. 😭)

---

🫶 See also 🫶

• constructor — constructs a directory iterator (public member function of std::filesystem::directory_iterator)
• constructor — constructs a recursive directory iterator (public member function of std::filesystem::recursive_directory_iterator)

---

🎀 Category 🎀

• Todo no example

---

⭐ cute lil sign-off: this page is straight from http://cppreference.com, version 2024.06.10, and yeah she's indexed as std::filesy...ory_options(3) — the truncated name is lowkey a vibe. bye bestie, go enumerate some directories 💜🌈