std::experi...y_iterator),(3)

🌸 NAME 🌸

okay so bestie, welcome to the C++ Standard Libary manual page for std::experi...y_iterator),(3) — yes, the header is truncated like that, we’re keeping the vibe, no cap. The NAME block is literally:

std::experimental::filesystem::begin(directory_iterator), -
std::experimental::filesystem::begin(directory_iterator),

(It really does say begin twice in the NAME block; I’m not fixing it, I’m just reporting it. 💅)

---

✨ Synopsis ✨

Two functions, both non-member, both filesystem TS, both here to make your range-based for loop era iconic:

directory_iterator begin( directory_iterator iter ); (1) (filesystem TS)
directory_iterator end( const directory_iterator& ); (2) (filesystem TS)

1. (1) returns iter unchanged.
2. (2) returns a default-constructed directory_iterator, which serves as the end iterator. The argument is ignored.

These non-member functions enable the use of directory_iterators with range-based for loops. 💖

🎀 Parameters 🎀

• iter — a directory_iterator.

🦋 Return value 🦋

1. iter unchanged.
2. End iterator (default-constructed directory_iterator).

🫶 Exceptions 🫶

The noexcept specification is: noexcept.

That’s it — that’s the whole section, and it’s giving unconditionally noexcept energy. The category list backs that up. 🫶

🌈 Example 🌈

The page says // Run this code, so here’s the code, bestie:

        #include <experimental/filesystem>
        #include <fstream>
        #include <iostream>
        namespace fs = std::experimental::filesystem;

        int main()
        {
            fs::create_directories("sandbox/a/b");
            std::ofstream("sandbox/file1.txt");
            std::ofstream("sandbox/file2.txt");
            for (auto& p : fs::directory_iterator("sandbox"))
                std::cout << p << '\n';
            fs::remove_all("sandbox");
        }

⭐ Possible output ⭐

        "sandbox/a"
        "sandbox/file1.txt"
        "sandbox/file2.txt"

🔥 See also 🔥

• filesystem::begin(filesystem::recursive_directory_iterator) — range-based for loop
• filesystem::end(filesystem::recursive_directory_iterator) — support (function)

👑 Categories 👑

• Noindexed pages
• unconditionally noexcept

💀 Hidden categories 💀

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

---

mwah 💋 — source/version is http://cppreference.com, dated 2024.06.10, page std::experi...y_iterator),(3). stay hydrated and may your directory_iterator always find the end iterator exactly when it should. 🫶✨