std::filesystem::begin(directory_iterator), std::filesystem::end(directory_iterator)

directory_iterator begin( directory_iterator iter );	(1)	(since C++17)
directory_iterator end( const directory_iterator& );	(2)	(since C++17)

1) Returns iter unchanged

2) Returns a default-constructed directory_iterator, which serves as the end iterator. The argument is ignored.

These non-member functions enable the use of directory_iterators with range-based for loops.

Parameters

iter

-

a directory_iterator

Return value

1) iter unchanged

2) End iterator (default-constructed directory_iterator)

Exceptions

noexcept specification:

noexcept

Example

Run this code

#include <fstream>
#include <iostream>
#include <filesystem>
namespace fs = std::filesystem;
 
int main()
{
    fs::create_directories("sandbox/a/b");
    std::ofstream("sandbox/file1.txt");
    std::ofstream("sandbox/file2.txt");
    for(auto& p: fs::directory_iterator("sandbox"))
        std::cout << p << '\n';
    fs::remove_all("sandbox");
}

Possible output:

"sandbox/a"
"sandbox/file1.txt"
"sandbox/file2.txt"

Language
Standard library headers
Concepts
Utilities library
Strings library
Containers library
Algorithms library
Iterators library
Numerics library
Input/output library
Localizations library
Regular expressions library (C++11)
Atomic operations library (C++11)
Thread support library (C++11)
Filesystem library (C++17)
Technical Specifications

Member functions
directory_iterator::directory_iterator
directory_iterator::operator*directory_iterator::operator->
directory_iterator::operator=
incrementoperator++
Non-member functions
beginstd::filesystem::(directory_iterator)endstd::filesystem::(directory_iterator)

std::filesystem::begin(directory_iterator), std::filesystem::end(directory_iterator)

Parameters

Return value

Exceptions

Example

See also