--- name: "std::filesystem_directory_entry" section: "3cxx" platform: "linux" package: "libstdc++-11-doc" version: "11.3.0-12" release: "Debian 12 (Bookworm)" platforms: ["linux"] url: "https://new.carta.tech/std::filesystem_directory_entry" --- # std::filesystem\_directory\_entry(3cxx) The value type used by directory iterators. ## NAME std::filesystem::directory\_entry - The value type used by directory iterators. ## SYNOPSIS `#include ` ### Public Member Functions **directory\_entry** (const **directory\_entry** &)=default\ **directory\_entry** (const **filesystem::path** &\_\_p)\ **directory\_entry** (const **filesystem::path** &\_\_p, **error\_code** &\_\_ec)\ **directory\_entry** (**directory\_entry** &&) noexcept=default\ void **assign** (const **filesystem::path** &\_\_p)\ void **assign** (const **filesystem::path** &\_\_p, **error\_code** &\_\_ec)\ bool **exists** () const\ bool **exists** (**error\_code** &\_\_ec) const noexcept\ uintmax\_t **file\_size** () const\ uintmax\_t **file\_size** (**error\_code** &\_\_ec) const noexcept\ uintmax\_t **hard\_link\_count** () const\ uintmax\_t **hard\_link\_count** (**error\_code** &\_\_ec) const noexcept\ bool **is\_block\_file** () const\ bool **is\_block\_file** (**error\_code** &\_\_ec) const noexcept\ bool **is\_character\_file** () const\ bool **is\_character\_file** (**error\_code** &\_\_ec) const noexcept\ bool **is\_directory** () const\ bool **is\_directory** (**error\_code** &\_\_ec) const noexcept\ bool **is\_fifo** () const\ bool **is\_fifo** (**error\_code** &\_\_ec) const noexcept\ bool **is\_other** () const\ bool **is\_other** (**error\_code** &\_\_ec) const noexcept\ bool **is\_regular\_file** () const\ bool **is\_regular\_file** (**error\_code** &\_\_ec) const noexcept\ bool **is\_socket** () const\ bool **is\_socket** (**error\_code** &\_\_ec) const noexcept\ bool **is\_symlink** () const\ bool **is\_symlink** (**error\_code** &\_\_ec) const noexcept\ **file\_time\_type** **last\_write\_time** () const\ **file\_time\_type** **last\_write\_time** (**error\_code** &\_\_ec) const noexcept\ **operator const filesystem::path &** () const noexcept\ bool **operator!=** (const **directory\_entry** &\_\_rhs) const noexcept\ bool **operator\<** (const **directory\_entry** &\_\_rhs) const noexcept\ bool **operator\<=** (const **directory\_entry** &\_\_rhs) const noexcept\ **directory\_entry** & **operator=** (const **directory\_entry** &)=default\ **directory\_entry** & **operator=** (**directory\_entry** &&) noexcept=default\ bool **operator==** (const **directory\_entry** &\_\_rhs) const noexcept\ bool **operator\>** (const **directory\_entry** &\_\_rhs) const noexcept\ bool **operator\>=** (const **directory\_entry** &\_\_rhs) const noexcept\ const **filesystem::path** & **path** () const noexcept\ void **refresh** ()\ void **refresh** (**error\_code** &\_\_ec) noexcept\ void **replace\_filename** (const **filesystem::path** &\_\_p)\ void **replace\_filename** (const **filesystem::path** &\_\_p, **error\_code** &\_\_ec)\ **file\_status** **status** () const\ **file\_status** **status** (**error\_code** &\_\_ec) const noexcept\ **file\_status** **symlink\_status** () const\ **file\_status** **symlink\_status** (**error\_code** &\_\_ec) const noexcept\ ### Friends struct **\_Dir**\ class **directory\_iterator**\ template\ **basic\_ostream**\< \_CharT, \_Traits \> & **operator\<\<** (**basic\_ostream**\< \_CharT, \_Traits \> &\_\_os, const **directory\_entry** &\_\_d)\ class **recursive\_directory\_iterator**\ ## Detailed Description The value type used by directory iterators. Definition at line **96** of file **bits/fs\_dir.h**. ## Constructor & Destructor Documentation ### std::filesystem::directory\_entry::directory\_entry (const filesystem::path & \_\_p)` [inline]`, ` [explicit]` Definition at line **105** of file **bits/fs\_dir.h**. ### std::filesystem::directory\_entry::directory\_entry (const filesystem::path & \_\_p, error\_code & \_\_ec)` [inline]` Definition at line **109** of file **bits/fs\_dir.h**. ## Member Function Documentation ### void std::filesystem::directory\_entry::assign (const filesystem::path & \_\_p)` [inline]` Definition at line **124** of file **bits/fs\_dir.h**. ### void std::filesystem::directory\_entry::assign (const filesystem::path & \_\_p, error\_code & \_\_ec)` [inline]` Definition at line **131** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::exists () const` [inline]` Definition at line **164** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::exists (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **168** of file **bits/fs\_dir.h**. ### uintmax\_t std::filesystem::directory\_entry::file\_size () const` [inline]` Definition at line **244** of file **bits/fs\_dir.h**. ### uintmax\_t std::filesystem::directory\_entry::file\_size (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **248** of file **bits/fs\_dir.h**. ### uintmax\_t std::filesystem::directory\_entry::hard\_link\_count () const` [inline]` Definition at line **252** of file **bits/fs\_dir.h**. ### uintmax\_t std::filesystem::directory\_entry::hard\_link\_count (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **256** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_block\_file () const` [inline]` Definition at line **172** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_block\_file (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **176** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_character\_file () const` [inline]` Definition at line **180** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_character\_file (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **184** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_directory () const` [inline]` Definition at line **188** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_directory (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **192** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_fifo () const` [inline]` Definition at line **196** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_fifo (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **200** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_other () const` [inline]` Definition at line **204** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_other (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **208** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_regular\_file () const` [inline]` Definition at line **212** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_regular\_file (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **216** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_socket () const` [inline]` Definition at line **220** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_socket (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **224** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_symlink () const` [inline]` Definition at line **228** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::is\_symlink (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **236** of file **bits/fs\_dir.h**. ### file\_time\_type std::filesystem::directory\_entry::last\_write\_time () const` [inline]` Definition at line **260** of file **bits/fs\_dir.h**. ### file\_time\_type std::filesystem::directory\_entry::last\_write\_time (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **265** of file **bits/fs\_dir.h**. ### std::filesystem::directory\_entry::operator const filesystem::path & () const` [inline]`, ` [noexcept]` Definition at line **161** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::operator!= (const directory\_entry & \_\_rhs) const` [inline]`, ` [noexcept]` Definition at line **294** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::operator\< (const directory\_entry & \_\_rhs) const` [inline]`, ` [noexcept]` Definition at line **297** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::operator\<= (const directory\_entry & \_\_rhs) const` [inline]`, ` [noexcept]` Definition at line **301** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::operator== (const directory\_entry & \_\_rhs) const` [inline]`, ` [noexcept]` Definition at line **285** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::operator\> (const directory\_entry & \_\_rhs) const` [inline]`, ` [noexcept]` Definition at line **306** of file **bits/fs\_dir.h**. ### bool std::filesystem::directory\_entry::operator\>= (const directory\_entry & \_\_rhs) const` [inline]`, ` [noexcept]` Definition at line **310** of file **bits/fs\_dir.h**. ### const filesystem::path & std::filesystem::directory\_entry::path () const` [inline]`, ` [noexcept]` Definition at line **160** of file **bits/fs\_dir.h**. ### void std::filesystem::directory\_entry::refresh ()` [inline]` Definition at line **152** of file **bits/fs\_dir.h**. ### void std::filesystem::directory\_entry::refresh (error\_code & \_\_ec)` [inline]`, ` [noexcept]` Definition at line **156** of file **bits/fs\_dir.h**. ### void std::filesystem::directory\_entry::replace\_filename (const filesystem::path & \_\_p)` [inline]` Definition at line **138** of file **bits/fs\_dir.h**. ### void std::filesystem::directory\_entry::replace\_filename (const filesystem::path & \_\_p, error\_code & \_\_ec)` [inline]` Definition at line **145** of file **bits/fs\_dir.h**. ### file\_status std::filesystem::directory\_entry::status () const` [inline]` Definition at line **269** of file **bits/fs\_dir.h**. ### file\_status std::filesystem::directory\_entry::status (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **273** of file **bits/fs\_dir.h**. ### file\_status std::filesystem::directory\_entry::symlink\_status () const` [inline]` Definition at line **277** of file **bits/fs\_dir.h**. ### file\_status std::filesystem::directory\_entry::symlink\_status (error\_code & \_\_ec) const` [inline]`, ` [noexcept]` Definition at line **281** of file **bits/fs\_dir.h**. ## Friends And Related Function Documentation ### friend struct \_Dir` [friend]` Definition at line **315** of file **bits/fs\_dir.h**. ### friend class directory\_iterator` [friend]` Definition at line **316** of file **bits/fs\_dir.h**. ### template\ basic\_ostream\< \_CharT, \_Traits \> & operator\<\< (basic\_ostream\< \_CharT, \_Traits \> & \_\_os, const directory\_entry & \_\_d)` [friend]` Definition at line **322** of file **bits/fs\_dir.h**. ### friend class recursive\_directory\_iterator` [friend]` Definition at line **317** of file **bits/fs\_dir.h**. ## Author Generated automatically by Doxygen for libstdc++ from the source code.