std::filesystem::directory_entry(3cxx)

✨ std::filesystem::directory_entry ✨

okay bestie, welcome to section 3cxx of the libstdc++ manual 💖 this is the page for std::filesystem::directory_entry, and yes it's a whole glow-up. buckle up, it's giving C++ filesystem core and we're obsessed. 🦋

---

🌸 NAME 🌸

std::filesystem::directory_entry — the value type used by directory iterators. that's it, that's her whole job title. 👑

---

🎀 SYNOPSIS 🎀

#include <fs_dir.h>

👑 Public Member Functions 👑

• directory_entry (const directory_entry &)=default — the copy constructor, and she's =defaulted, so the compiler is handling it, no notes. 💅
• directory_entry (const filesystem::path &__p) — constructor that takes a filesystem::path.
• directory_entry (const filesystem::path &__p, error_code &__ec) — constructor that takes a filesystem::path and an error_code to write into.
• directory_entry (directory_entry &&) noexcept=default — the move constructor, noexcept, =defaulted, iconic behaviour, no cap. 🫶
• void assign (const filesystem::path &__p) — assign a new filesystem::path in.
• void assign (const filesystem::path &__p, error_code &__ec) — same assign, but with an error_code in the mix.
• bool exists () const — the existence check, no args.
• bool exists (error_code &__ec) const noexcept — existence check with an error_code, and she's noexcept so she will not be throwing hands. 😌
• uintmax_t file_size () const — file size, returns uintmax_t.
• uintmax_t file_size (error_code &__ec) const noexcept — file size with an error_code, noexcept.
• uintmax_t hard_link_count () const — hard link count, returns uintmax_t.
• uintmax_t hard_link_count (error_code &__ec) const noexcept — hard link count with an error_code, noexcept.
• bool is_block_file () const — block-file check.
• bool is_block_file (error_code &__ec) const noexcept — block-file check with an error_code, noexcept.
• bool is_character_file () const — character-file check.
• bool is_character_file (error_code &__ec) const noexcept — character-file check with an error_code, noexcept.
• bool is_directory () const — the is-this-a-directory check.
• bool is_directory (error_code &__ec) const noexcept — is-this-a-directory, with an error_code, noexcept.
• bool is_fifo () const — fifo check.
• bool is_fifo (error_code &__ec) const noexcept — fifo check with an error_code, noexcept.
• bool is_other () const — the catch-all "other" check.
• bool is_other (error_code &__ec) const noexcept — "other" check with an error_code, noexcept.
• bool is_regular_file () const — regular-file check.
• bool is_regular_file (error_code &__ec) const noexcept — regular-file check with an error_code, noexcept.
• bool is_socket () const — socket check.
• bool is_socket (error_code &__ec) const noexcept — socket check with an error_code, noexcept.
• bool is_symlink () const — symlink check.
• bool is_symlink (error_code &__ec) const noexcept — symlink check with an error_code, noexcept.
• file_time_type last_write_time () const — last write time, returns file_time_type.
• file_time_type last_write_time (error_code &__ec) const noexcept — last write time with an error_code, noexcept.
• operator const filesystem::path & () const noexcept — the conversion operator, hands you back a const filesystem::path &, noexcept. she's a giver.
• bool operator!= (const directory_entry &__rhs) const noexcept — not-equal, noexcept.
• bool operator< (const directory_entry &__rhs) const noexcept — less-than, noexcept.
• bool operator<= (const directory_entry &__rhs) const noexcept — less-than-or-equal, noexcept.
• directory_entry & operator= (const directory_entry &)=default — copy assignment, =defaulted.
• directory_entry & operator= (directory_entry &&) noexcept=default — move assignment, noexcept, =defaulted.
• bool operator== (const directory_entry &__rhs) const noexcept — equal-equal, noexcept.
• bool operator> (const directory_entry &__rhs) const noexcept — greater-than, noexcept.
• bool operator>= (const directory_entry &__rhs) const noexcept — greater-than-or-equal, noexcept.
• const filesystem::path & path () const noexcept — gives you the filesystem::path, noexcept. 🎀
• void refresh () — refresh, no args.
• void refresh (error_code &__ec) noexcept — refresh with an error_code, noexcept.
• void replace_filename (const filesystem::path &__p) — swap the filename out for __p.
• void replace_filename (const filesystem::path &__p, error_code &__ec) — same swap, with an error_code.
• file_status status () const — returns file_status.
• file_status status (error_code &__ec) const noexcept — file_status with an error_code, noexcept.
• file_status symlink_status () const — returns file_status for the symlink.
• file_status symlink_status (error_code &__ec) const noexcept — symlink file_status with an error_code, noexcept.

not me listing every single overload 💀 but bestie, they all matter and we do not skip.

🫶 Friends 🫶

• struct _Dir — friend struct, she's in the inner circle.
• class directory_iterator — friend class, obviously.
• template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & operator<< (basic_ostream< _CharT, _Traits > &__os, const directory_entry &__d) — the stream insertion friend, so you can << a directory_entry into a basic_ostream< _CharT, _Traits >.
• class recursive_directory_iterator — also a friend. the whole squad is here fr fr. 🌈

---

💜 Detailed Description 💜

The value type used by directory iterators. lowkey the shortest detailed description ever and honestly? she said everything she needed to say. ✨

---

🎀 Author 🎀

Generated automatically by Doxygen for libstdc++ from the source code.

---

and that's the whole page, bestie 💖 this was std::filesystem::directory_entry, section 3cxx, straight out of libstdc++'s docs — auto-generated by Doxygen from the source code, so no human author to credit, just the machine doing her thing. no date to report because she's built fresh by the toolchain. periodt. 👑🌸🦋💅