View source for cpp/experimental/fs/directory iterator

← cpp/experimental/fs/directory iterator

You do not have permission to edit this page, for the following reasons:

The action you have requested is limited to users in one of the groups: Users, Administrators.

Due to recent vandalism, editing of this page is temporarily disabled for new users.If you want to suggest a change, please leave a message on the suggestions page for new users instead (don't be surprised if that page appears vandalized!).

You can view and copy the source of this page.

{{cpp/experimental/fs/title|directory_iterator}}
{{cpp/experimental/fs/directory_iterator/navbar}}
{{fmbox|class=noprint|style=font-size: 0.8em|text='''Merged into ISO C++''' The functionality described on this page was merged into the mainline ISO C++ standard as of 3/2016; see [[cpp/filesystem/directory_iterator|std::filesystem::directory_iterator]] {{mark since c++17}}}}

{{dcl begin}}
{{dcl header|experimental/filesystem}}
{{dcl|since=fs_ts|1=
class directory_iterator;
}}
{{dcl end}}

{{tt|directory_iterator}} is a {{named req|InputIterator}} that iterates over the {{ltt|cpp/experimental/fs/directory_entry|directory_entry}} elements of a directory (but does not visit the subdirectories). The iteration order is unspecified, except that each directory entry is visited only once. The special pathnames {{spar|dot}} and {{spar|dot-dot}} are skipped.

If the {{tt|directory_iterator}} is advanced past the last directory entry, it becomes equal to the default-constructed iterator, also known as the end iterator. Two end iterators are always equal, dereferencing or incrementing the end iterator is undefined behavior.

If a file or a directory is deleted or added to the directory tree after the directory iterator has been created, it is unspecified whether the change would be observed through the iterator.

===Member types===
{{dsc begin}}
{{dsc hitem|Member type|Definition}}
{{dsc|{{tt|value_type}}|{{tt|filesystem::directory_entry}}}}
{{dsc|{{tt|difference_type}}|{{tt|std::ptrdiff_t}}}}
{{dsc|{{tt|pointer}}|{{tt|const filesystem::directory_entry*}}}}
{{dsc|{{tt|reference}}|{{tt|const filesystem::directory_entry&}}}}
{{dsc|{{tt|iterator_category}}|{{tt|std::input_iterator_tag}}}}
{{dsc end}}

===Member functions===
{{dsc begin}}
{{dsc inc|cpp/experimental/fs/directory_iterator/dsc constructor}}
{{dsc inc|cpp/experimental/fs/directory_iterator/dsc destructor}}
{{dsc inc|cpp/experimental/fs/directory_iterator/dsc operator{{=}}}}
{{dsc inc|cpp/experimental/fs/directory_iterator/dsc operator*}}
{{dsc inc|cpp/experimental/fs/directory_iterator/dsc increment}}
{{dsc end}}

===Non-member functions===
{{dsc begin}}
{{dsc inc|cpp/experimental/fs/directory_iterator/dsc begin}}
{{dsc end}}

Additionally, {{c|operator{{==}}}} and {{c|operator!{{=}}}} are provided, either as members or as non-members, as required by {{named req|InputIterator}}.

===Example===
{{example|code=
#include <experimental/filesystem>
#include <fstream>
#include <iostream>
namespace fs = std::experimental::filesystem;

int main()
{
    fs::create_directories("sandbox/a/b");
    std::ofstream{"sandbox/file1.txt"};
    std::ofstream{"sandbox/file2.txt"};
    for (const fs::directory_entry& entry : fs::directory_iterator{"sandbox"})
        std::cout << entry << '\n';
    fs::remove_all("sandbox");
}
|p=true
|output=
"sandbox/a"
"sandbox/file1.txt"
"sandbox/file2.txt"
}}

===See also===
{{dsc begin}}
{{dsc inc|cpp/experimental/fs/dsc recursive_directory_iterator}}
{{dsc inc|cpp/experimental/fs/dsc directory_options}}
{{dsc inc|cpp/experimental/fs/dsc directory_entry}}
{{dsc end}}

Templates used on this page:

Template:== (view source)
Template:c (view source) (protected)
Template:cpp/experimental/fs/directory iterator/dsc begin (view source)
Template:cpp/experimental/fs/directory iterator/dsc constructor (view source)
Template:cpp/experimental/fs/directory iterator/dsc destructor (view source)
Template:cpp/experimental/fs/directory iterator/dsc increment (view source)
Template:cpp/experimental/fs/directory iterator/dsc operator* (view source)
Template:cpp/experimental/fs/directory iterator/dsc operator= (view source)
Template:cpp/experimental/fs/directory iterator/navbar (view source)
Template:cpp/experimental/fs/directory iterator/navbar content (view source)
Template:cpp/experimental/fs/directory iterator/navbar heading (view source)
Template:cpp/experimental/fs/dsc directory entry (view source)
Template:cpp/experimental/fs/dsc directory options (view source)
Template:cpp/experimental/fs/dsc recursive directory iterator (view source)
Template:cpp/experimental/fs/navbar content (view source)
Template:cpp/experimental/fs/navbar heading (view source)
Template:cpp/experimental/fs/title (view source)
Template:cpp/navbar content (view source)
Template:cpp/navbar heading (view source)
Template:cpp/title (view source) (protected)
Template:ctitle (view source) (protected)
Template:dcl (view source) (protected)
Template:dcl/std (view source) (semi-protected)
Template:dcl begin (view source) (protected)
Template:dcl end (view source) (protected)
Template:dcl header (view source) (protected)
Template:dcl list header/link (view source)
Template:dcl sep (view source) (protected)
Template:dsc (view source) (protected)
Template:dsc begin (view source) (protected)
Template:dsc class (view source) (protected)
Template:dsc editlink (view source)
Template:dsc end (view source) (protected)
Template:dsc enum (view source) (protected)
Template:dsc fun (view source) (protected)
Template:dsc guard (view source) (protected)
Template:dsc header/link (view source)
Template:dsc hitem (view source) (protected)
Template:dsc inc (view source) (protected)
Template:dsc mark mem (view source) (protected)
Template:dsc mem ctor (view source) (protected)
Template:dsc mem dtor (view source) (protected)
Template:dsc mem fun (view source) (protected)
Template:dsc member (view source) (protected)
Template:dsc small (view source)
Template:example (view source) (protected)
Template:fmbox (view source)
Template:get lang (view source) (protected)
Template:lines (view source) (protected)
Template:ltt (view source) (protected)
Template:ltt/core (view source) (protected)
Template:mark (view source) (protected)
Template:mark c++11 (view source) (protected)
Template:mark c++17 (view source) (protected)
Template:mark c++20 (view source)
Template:mark c++26 (view source)
Template:mark class (view source) (protected)
Template:mark enum (view source) (protected)
Template:mark fun (view source) (protected)
Template:mark mem fun (view source) (protected)
Template:mark rev (view source) (protected)
Template:mark since c++17 (view source)
Template:mark since fs ts (view source)
Template:named req (view source)
Template:named req/core (view source)
Template:navbar (view source)

cppreference.com

Search

Namespaces

Variants

Views

Actions

View source for cpp/experimental/fs/directory iterator