Provided by: libstdc++-13-doc_13-20230320-1ubuntu1_all bug

NAME

       std::filesystem::directory_entry - The value type used by directory iterators.

SYNOPSIS

       #include <filesystem>

   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<typename _CharT , typename _Traits > 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 97 of file bits/filesystem.

Constructor & Destructor Documentation

   std::filesystem::directory_entry::directory_entry (const filesystem::path & __p) [inline],
       [explicit]
       Definition at line 106 of file bits/filesystem.

   std::filesystem::directory_entry::directory_entry (const filesystem::path & __p, error_code &
       __ec) [inline]
       Definition at line 110 of file bits/filesystem.

Member Function Documentation

   void std::filesystem::directory_entry::assign (const filesystem::path & __p) [inline]
       Definition at line 125 of file bits/filesystem.

   void std::filesystem::directory_entry::assign (const filesystem::path & __p, error_code &
       __ec) [inline]
       Definition at line 132 of file bits/filesystem.

   bool std::filesystem::directory_entry::exists () const [inline]
       Definition at line 165 of file bits/filesystem.

   bool std::filesystem::directory_entry::exists (error_code & __ec) const [inline],  [noexcept]
       Definition at line 169 of file bits/filesystem.

   uintmax_t std::filesystem::directory_entry::file_size () const [inline]
       Definition at line 245 of file bits/filesystem.

   uintmax_t std::filesystem::directory_entry::file_size (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 249 of file bits/filesystem.

   uintmax_t std::filesystem::directory_entry::hard_link_count () const [inline]
       Definition at line 253 of file bits/filesystem.

   uintmax_t std::filesystem::directory_entry::hard_link_count (error_code & __ec) const
       [inline],  [noexcept]
       Definition at line 257 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_block_file () const [inline]
       Definition at line 173 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_block_file (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 177 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_character_file () const [inline]
       Definition at line 181 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_character_file (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 185 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_directory () const [inline]
       Definition at line 189 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_directory (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 193 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_fifo () const [inline]
       Definition at line 197 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_fifo (error_code & __ec) const [inline],  [noexcept]
       Definition at line 201 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_other () const [inline]
       Definition at line 205 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_other (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 209 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_regular_file () const [inline]
       Definition at line 213 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_regular_file (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 217 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_socket () const [inline]
       Definition at line 221 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_socket (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 225 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_symlink () const [inline]
       Definition at line 229 of file bits/filesystem.

   bool std::filesystem::directory_entry::is_symlink (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 237 of file bits/filesystem.

   file_time_type std::filesystem::directory_entry::last_write_time () const [inline]
       Definition at line 261 of file bits/filesystem.

   file_time_type std::filesystem::directory_entry::last_write_time (error_code & __ec) const
       [inline],  [noexcept]
       Definition at line 266 of file bits/filesystem.

   std::filesystem::directory_entry::operator const filesystem::path & () const [inline],
       [noexcept]
       Definition at line 162 of file bits/filesystem.

   bool std::filesystem::directory_entry::operator!= (const directory_entry & __rhs) const
       [inline],  [noexcept]
       Definition at line 295 of file bits/filesystem.

   bool std::filesystem::directory_entry::operator< (const directory_entry & __rhs) const
       [inline],  [noexcept]
       Definition at line 298 of file bits/filesystem.

   bool std::filesystem::directory_entry::operator<= (const directory_entry & __rhs) const
       [inline],  [noexcept]
       Definition at line 302 of file bits/filesystem.

   bool std::filesystem::directory_entry::operator== (const directory_entry & __rhs) const
       [inline],  [noexcept]
       Definition at line 286 of file bits/filesystem.

   bool std::filesystem::directory_entry::operator> (const directory_entry & __rhs) const
       [inline],  [noexcept]
       Definition at line 307 of file bits/filesystem.

   bool std::filesystem::directory_entry::operator>= (const directory_entry & __rhs) const
       [inline],  [noexcept]
       Definition at line 311 of file bits/filesystem.

   const filesystem::path & std::filesystem::directory_entry::path () const [inline],  [noexcept]
       Definition at line 161 of file bits/filesystem.

   void std::filesystem::directory_entry::refresh () [inline]
       Definition at line 153 of file bits/filesystem.

   void std::filesystem::directory_entry::refresh (error_code & __ec) [inline],  [noexcept]
       Definition at line 157 of file bits/filesystem.

   void std::filesystem::directory_entry::replace_filename (const filesystem::path & __p)
       [inline]
       Definition at line 139 of file bits/filesystem.

   void std::filesystem::directory_entry::replace_filename (const filesystem::path & __p,
       error_code & __ec) [inline]
       Definition at line 146 of file bits/filesystem.

   file_status std::filesystem::directory_entry::status () const [inline]
       Definition at line 270 of file bits/filesystem.

   file_status std::filesystem::directory_entry::status (error_code & __ec) const [inline],
       [noexcept]
       Definition at line 274 of file bits/filesystem.

   file_status std::filesystem::directory_entry::symlink_status () const [inline]
       Definition at line 278 of file bits/filesystem.

   file_status std::filesystem::directory_entry::symlink_status (error_code & __ec) const
       [inline],  [noexcept]
       Definition at line 282 of file bits/filesystem.

Friends And Related Function Documentation

   friend struct _Dir [friend]
       Definition at line 316 of file bits/filesystem.

   friend class directory_iterator [friend]
       Definition at line 317 of file bits/filesystem.

   template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & operator<<
       (basic_ostream< _CharT, _Traits > & __os, const directory_entry & __d) [friend]
       Definition at line 323 of file bits/filesystem.

   friend class recursive_directory_iterator [friend]
       Definition at line 318 of file bits/filesystem.

Author

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