[fs.class.directory.iterator]

Files changed (1) hide show

tmp/tmpmo9j2ti5/{from.md → to.md} +16 -10

tmp/tmpmo9j2ti5/{from.md → to.md} RENAMED Viewed

@@ -1,13 +1,15 @@
 ### Class `directory_iterator` <a id="fs.class.directory.iterator">[[fs.class.directory.iterator]]</a>
 An object of type `directory_iterator` provides an iterator for a
 sequence of `directory_entry` elements representing the path and any
 cached attribute values [[fs.class.directory.entry]] for each file in a
 directory or in an *implementation-defined* directory-like file type.
-[*Note 1*: For iteration into sub-directories, see class
 `recursive_directory_iterator` [[fs.class.rec.dir.itr]]. — *end note*]
 ``` cpp
 namespace std::filesystem {
   class directory_iterator {
@@ -35,10 +37,14 @@ namespace std::filesystem {
     const directory_entry& operator*() const;
     const directory_entry* operator->() const;
     directory_iterator&    operator++();
     directory_iterator&    increment(error_code& ec);
     // other members as required by [input.iterators], input iterators
   };
 }
 ```
@@ -57,12 +63,12 @@ Two end iterators are always equal. An end iterator shall not be equal
 to a non-end iterator.
 The result of calling the `path()` member of the `directory_entry`
 object obtained by dereferencing a `directory_iterator` is a reference
 to a `path` object composed of the directory argument from which the
-iterator was constructed with filename of the directory entry appended
-as if by `operator/=`.
 Directory iteration shall not yield directory entries for the current
 (dot) and parent (dot-dot) directories.
 The order of directory entries obtained by dereferencing successive
@@ -77,21 +83,21 @@ call any `directory_entry` `refresh` function.
 [*Note 2*: The exact mechanism for storing cached attribute values is
 not exposed to users. For exposition, class `directory_iterator` is
 shown in [[fs.class.directory.entry]] as a friend of class
 `directory_entry`. — *end note*]
-[*Note 3*: Programs performing directory iteration may wish to test if
-the path obtained by dereferencing a directory iterator actually exists.
-It could be a symbolic link to a non-existent file. Programs recursively
-walking directory trees for purposes of removing and renaming entries
-may wish to avoid following symbolic links. — *end note*]
 [*Note 4*: If a file is removed from or added to a directory after the
 construction of a `directory_iterator` for the directory, it is
 unspecified whether or not subsequently incrementing the iterator will
 ever result in an iterator referencing the removed or added directory
-entry. See POSIX `readdir_r`. — *end note*]
 #### Members <a id="fs.dir.itr.members">[[fs.dir.itr.members]]</a>
 ``` cpp
 directory_iterator() noexcept;
@@ -165,10 +171,10 @@ directory_iterator begin(directory_iterator iter) noexcept;
 ```
 *Returns:* `iter`.
 ``` cpp
-directory_iterator end(const directory_iterator&) noexcept;
 ```
 *Returns:* `directory_iterator()`.

 ### Class `directory_iterator` <a id="fs.class.directory.iterator">[[fs.class.directory.iterator]]</a>
+#### General <a id="fs.class.directory.iterator.general">[[fs.class.directory.iterator.general]]</a>
 An object of type `directory_iterator` provides an iterator for a
 sequence of `directory_entry` elements representing the path and any
 cached attribute values [[fs.class.directory.entry]] for each file in a
 directory or in an *implementation-defined* directory-like file type.
+[*Note 1*: For iteration into subdirectories, see class
 `recursive_directory_iterator` [[fs.class.rec.dir.itr]]. — *end note*]
 ``` cpp
 namespace std::filesystem {
   class directory_iterator {
     const directory_entry& operator*() const;
     const directory_entry* operator->() const;
     directory_iterator&    operator++();
     directory_iterator&    increment(error_code& ec);
+    bool operator==(default_sentinel_t) const noexcept {
+      return *this == directory_iterator();
+    }
     // other members as required by [input.iterators], input iterators
   };
 }
 ```
 to a non-end iterator.
 The result of calling the `path()` member of the `directory_entry`
 object obtained by dereferencing a `directory_iterator` is a reference
 to a `path` object composed of the directory argument from which the
+iterator was constructed with the filename of the directory entry
+appended as if by `operator/=`.
 Directory iteration shall not yield directory entries for the current
 (dot) and parent (dot-dot) directories.
 The order of directory entries obtained by dereferencing successive
 [*Note 2*: The exact mechanism for storing cached attribute values is
 not exposed to users. For exposition, class `directory_iterator` is
 shown in [[fs.class.directory.entry]] as a friend of class
 `directory_entry`. — *end note*]
+[*Note 3*: A path obtained by dereferencing a directory iterator might
+not actually exist; it could be a symbolic link to a non-existent file.
+Recursively walking directory trees for purposes of removing and
+renaming entries might invalidate symbolic links that are being
+followed. — *end note*]
 [*Note 4*: If a file is removed from or added to a directory after the
 construction of a `directory_iterator` for the directory, it is
 unspecified whether or not subsequently incrementing the iterator will
 ever result in an iterator referencing the removed or added directory
+entry. See POSIX `readdir`. — *end note*]
 #### Members <a id="fs.dir.itr.members">[[fs.dir.itr.members]]</a>
 ``` cpp
 directory_iterator() noexcept;
 ```
 *Returns:* `iter`.
 ``` cpp
+directory_iterator end(directory_iterator) noexcept;
 ```
 *Returns:* `directory_iterator()`.

Diff to HTML by rtfpessoa