std::filesystem::recursive_directory_iterator::recursive_directory_iterator

recursive_directory_iterator() noexcept;

recursive_directory_iterator( const recursive_directory_iterator& rhs );

recursive_directory_iterator( recursive_directory_iterator&& rhs ) noexcept;

explicit recursive_directory_iterator( const std::filesystem::path& p );

recursive_directory_iterator(
    const std::filesystem::path& p,
    std::filesystem::directory_options options );

recursive_directory_iterator(
    const std::filesystem::path& p,
    std::filesystem::directory_options options,
    std::error_code& ec );

recursive_directory_iterator( const std::filesystem::path& p, std::error_code& ec );

Constructs new recursive directory iterator.

Parameters

Exceptions

The overload that does not take a std::error_code& parameter throws filesystem::filesystem_error on underlying OS API errors, constructed with p as the first path argument and the OS error code as the error code argument. The overload taking a std::error_code& parameter sets it to the OS API error code if an OS API call fails, and executes ec.clear() if no errors occur. Any overload not marked noexcept may throw std::bad_alloc if memory allocation fails.

Notes

Recursive directory iterators do not follow directory symlinks by default. To enable this behavior, specify directory_options::follow_directory_symlink among the options option set.

Example

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.