std::filesy...entry::path(3)

✨ std::filesystem::directory_entry::path ✨

okay bestie, so this is a page straight out of the C++ Standard Libary (their spelling, not mine 💅) — it's std::filesystem::directory_entry::path, and honestly it's giving "small but mighty."

🌸 NAME 🌸

std::filesystem::directory_entry::path — yes, the name is the whole thing twice, that's just how the standard library does it, periodt.

🎀 Synopsis 🎀

const std::filesystem::path& path() const noexcept;       (since C++17)
operator const std::filesystem::path& () const noexcept;  (since C++17)

So you get two ways in — the named path() getter and the conversion operator — both noexcept, both const, both since C++17. Two icons, same energy fr fr. 💖

What does it do? It returns the full path the directory entry refers to. That's the whole vibe check.

🦋 Parameters 🦋

(none) — literally none, it takes zero arguments, it's low-maintenance like that 🙈

⭐ Return value ⭐

The full path the directory entry refers to. Exactly what it says on the tin, no plot twist. 🫶

🔥 Example 🔥

Run this code

#include <filesystem>
#include <fstream>
#include <iostream>

namespace fs = std::filesystem;

std::string get_stem(const fs::path& p) { return p.stem().string(); }
void create_file(const fs::path& p) { std::ofstream o{p}; }

int main()
{
    const fs::path dir{"tmp_dir"};
    fs::create_directory(dir);
    create_file(dir / "one");
    create_file(dir / "two");
    create_file(dir / "three");

    for (const auto& file : fs::directory_iterator(dir))
    {
        // Explicit conversion
        std::cout << get_stem(file.path()) << '\n';

        // Implicit conversion
        std::cout << get_stem(file) << '\n';
    }

    fs::remove_all(dir);
}

Bestie look at this — they call get_stem(file.path()) (explicit conversion) and then just get_stem(file) (implicit conversion), and both work because of that operator const std::filesystem::path&. That's the moment. 🫢✨

💜 Possible output 💜

two
two
one
one
three
three

(note the "possible" — it's a directory iterator, the order is not the point, the doubling is the point 👑)

🌈 See also 🌈

• path — represents a path (C++17) (class)

okay that's the tea 🍓 — this page came from http://cppreference.com, dated 2024.06.10, and you can find it filed under std::filesy...entry::path(3) in the C++ Standard Libary, mwah 💅🧚💖