std::files...tory_entry(3)

💖 NAME 💖

std::filesystem::directory_entry — the value type used by directory iterators. That's the whole job description, and she does it flawlessly.

Okay so hi bestie, welcome to the Library Functions Manual 🌸 this is the page for std::filesystem::directory_entry, the little icon that directory iterators hand you when they walk past an entry. Let's get into it 💅

---

✨ SYNOPSIS ✨

#include <filesystem>

🎀 Public Member Functions 🎀

• directory_entry (const directory_entry &)=default — copy constructor, defaulted, zero notes, pure vibes.
• directory_entry (const filesystem::path &__p) — build one from a filesystem::path.
• directory_entry (const filesystem::path &__p, error_code &__ec) — same thing but it takes an error_code &__ec along for the ride.
• directory_entry (directory_entry &&) noexcept=default — move constructor, defaulted, noexcept, iconic.
• void assign (const filesystem::path &__p) — assign a new filesystem::path.
• void assign (const filesystem::path &__p, error_code &__ec) — the error_code &__ec twin.
• bool exists () const — does it exist, yes or no, const.
• bool exists (error_code &__ec) const noexcept — the error_code &__ec version, const and noexcept.
• uintmax_t file_size () const — size of the file, as a uintmax_t.
• uintmax_t file_size (error_code &__ec) const noexcept — with error_code &__ec, const, noexcept.
• uintmax_t hard_link_count () const — how many hard links, as a uintmax_t.
• uintmax_t hard_link_count (error_code &__ec) const noexcept — error_code &__ec flavour, const, noexcept.
• bool is_block_file () const — is it a block file? const bool, bestie.
• bool is_block_file (error_code &__ec) const noexcept — error_code &__ec version, const, noexcept.
• bool is_character_file () const — character file check, const.
• bool is_character_file (error_code &__ec) const noexcept — with error_code &__ec, const, noexcept.
• bool is_directory () const — directory check, const.
• bool is_directory (error_code &__ec) const noexcept — error_code &__ec twin, const, noexcept.
• bool is_fifo () const — FIFO check, const.
• bool is_fifo (error_code &__ec) const noexcept — error_code &__ec twin, const, noexcept.
• bool is_other () const — the "none of the above" check, const.
• bool is_other (error_code &__ec) const noexcept — error_code &__ec version, const, noexcept.
• bool is_regular_file () const — regular file check, const.
• bool is_regular_file (error_code &__ec) const noexcept — error_code &__ec version, const, noexcept.
• bool is_socket () const — socket check, const.
• bool is_socket (error_code &__ec) const noexcept — error_code &__ec version, const, noexcept.
• bool is_symlink () const — symlink check, const.
• bool is_symlink (error_code &__ec) const noexcept — error_code &__ec version, const, noexcept.
• file_time_type last_write_time () const — last write time, returned as a file_time_type.
• file_time_type last_write_time (error_code &__ec) const noexcept — error_code &__ec version, const, noexcept.
• operator const filesystem::path & () const noexcept — implicit conversion to const filesystem::path &, const, noexcept, slay.
• strong_ordering operator<=> (const directory_entry &__rhs) const noexcept — the spaceship, returns strong_ordering, takes const directory_entry &__rhs, const, noexcept. three-way comparison ate and left no crumbs 🚀
• directory_entry & operator= (const directory_entry &)=default — copy assignment, defaulted.
• directory_entry & operator= (directory_entry &&) noexcept=default — move assignment, defaulted, noexcept.
• bool operator== (const directory_entry &__rhs) const noexcept — equality against const directory_entry &__rhs, const, noexcept.
• const filesystem::path & path () const noexcept — hands you the const filesystem::path &, const, noexcept.
• void refresh () — refresh, no args.
• void refresh (error_code &__ec) noexcept — refresh with error_code &__ec, noexcept.
• void replace_filename (const filesystem::path &__p) — swap in a new filename from a filesystem::path.
• void replace_filename (const filesystem::path &__p, error_code &__ec) — with error_code &__ec.
• file_status status () const — returns a file_status, const.
• file_status status (error_code &__ec) const noexcept — error_code &__ec version, const, noexcept.
• file_status symlink_status () const — returns a file_status, const.
• file_status symlink_status (error_code &__ec) const noexcept — error_code &__ec version, const, noexcept.

🫶 Friends 🫶

the inner circle. the group chat. the ones who get to see behind the curtain 🔥

• struct _Dir
• class directory_iterator
• template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & operator<< (basic_ostream< _CharT, _Traits > &__os, const directory_entry &__d) — yes bestie she streams, she's printable, she's in your basic_ostream< _CharT, _Traits > 💖
• class recursive_directory_iterator

---

💅 Detailed Description 💅

The value type used by directory iterators. that's it. that's the detailed description. she said what she said 🎀

⭐ Since ⭐

C++17

---

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. no cap, a robot wrote this and honestly? it ate.

---

ok that's the whole page bestie, every signature accounted for, nothing skipped, nothing invented. go forth and iterate 🦋

and that's a wrap on std::files...tory_entry(3) from the libstdc++ girlies — mwah 💋 🫶 </final>