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

C++

Language

Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

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

Filesystem library

Classes
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator filesystem::file_status	filesystem::space_info filesystem::file_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options filesystem::file_time_type
Functions
filesystem::absolute filesystem::canonicalfilesystem::weakly_canonical filesystem::relativefilesystem::proximate filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path	filesystem::exists filesystem::equivalent filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status filesystem::temp_directory_path
File types
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

std::filesystem::directory_iterator

Member functions

directory_iterator::directory_iterator

directory_iterator::operator*directory_iterator::operator->

directory_iterator::operator=

incrementoperator++

Non-member functions

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

directory_iterator begin( directory_iterator iter ) noexcept;	(1)	(since C++17)
directory_iterator end( const directory_iterator& ) noexcept;	(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)

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"

See also

begin(std::filesystem::recursive_directory_iterator)end(std::filesystem::recursive_directory_iterator)

range-based for loop support (function)