29 Input/output library [input.output]

29.11 File systems [filesystems]

29.11.13 Class recursive_directory_iterator [fs.class.rec.dir.itr]

29.11.13.1 Members [fs.rec.dir.itr.members]

recursive_directory_iterator() noexcept;

Effects: Constructs the end iterator.

🔗

explicit recursive_directory_iterator(const path& p);
recursive_directory_iterator(const path& p, directory_options options);
recursive_directory_iterator(const path& p, directory_options options, error_code& ec);
recursive_directory_iterator(const path& p, error_code& ec);

Effects: Constructs an iterator representing the first entry in the directory to which p resolves, if any; otherwise, the end iterator.

However, if

(options & directory_options::skip_permission_denied) != directory_options::none

and construction encounters an error indicating that permission to access p is denied, constructs the end iterator and does not report an error.

Postconditions: options() == options for the signatures with a directory_options argument, otherwise options() == directory_options::none.

Throws: As specified in [fs.err.report].

[Note

To iterate over the current directory, use recursive_directory_iterator(".") rather than recursive_directory_iterator("").

— end note

]

[Note

By default, recursive_directory_iterator does not follow directory symlinks.

To follow directory symlinks, specify options as directory_options::follow_directory_symlink.

— end note

]

🔗

recursive_directory_iterator(const recursive_directory_iterator& rhs);

Postconditions:

(7.1)
options() == rhs.options()
(7.2)
depth() == rhs.depth()
(7.3)
recursion_pending() == rhs.recursion_pending()

🔗

recursive_directory_iterator(recursive_directory_iterator&& rhs) noexcept;

Postconditions: options(), depth(), and recursion_pending() have the values that rhs.options(), rhs.depth(), and rhs.recursion_pending(), respectively, had before the function call.

🔗

recursive_directory_iterator& operator=(const recursive_directory_iterator& rhs);

Effects: If *this and rhs are the same object, the member has no effect.

Postconditions:

(10.1)
options() == rhs.options()
(10.2)
depth() == rhs.depth()
(10.3)
recursion_pending() == rhs.recursion_pending()

Returns: *this.

🔗

recursive_directory_iterator& operator=(recursive_directory_iterator&& rhs) noexcept;

Effects: If *this and rhs are the same object, the member has no effect.

Postconditions: options(), depth(), and recursion_pending() have the values that rhs.options(), rhs.depth(), and rhs.recursion_pending(), respectively, had before the function call.

Returns: *this.

🔗

directory_options options() const;

Returns: The value of the argument passed to the constructor for the options parameter, if present, otherwise directory_options::none.

Throws: Nothing.

🔗

int depth() const;

Returns: The current depth of the directory tree being traversed.

[Note

The initial directory is depth 0, its immediate subdirectories are depth 1, and so forth.

— end note

]

Throws: Nothing.

🔗

bool recursion_pending() const;

Returns: true if disable_recursion_pending() has not been called subsequent to the prior construction or increment operation, otherwise false.

Throws: Nothing.

🔗

recursive_directory_iterator& operator++();
recursive_directory_iterator& increment(error_code& ec);

Effects: As specified for the prefix increment operation of Input iterators, except that:

(21.1)
If there are no more entries at the current depth, then if depth() != 0 iteration over the parent directory resumes; otherwise *this = recursive_directory_iterator().

(21.2)

Otherwise if

recursion_pending() && is_directory((*this)->status()) &&
(!is_symlink((*this)->symlink_status()) ||
 (options() & directory_options::follow_directory_symlink) != directory_options::none)

then either directory (*this)->path() is recursively iterated into or, if

(options() & directory_options::skip_permission_denied) != directory_options::none

and an error occurs indicating that permission to access directory (*this)->path() is denied, then directory (*this)->path() is treated as an empty directory and no error is reported.

Returns: *this.

Throws: As specified in [fs.err.report].

🔗