std::filesystem::directory_iterator

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

ファイルシステムライブラリ

クラス
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::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
関数
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::temp_directory_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::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

メンバ関数

directory_iterator::directory_iterator

directory_iterator::operator*directory_iterator::operator->

directory_iterator::operator=

incrementoperator++

非メンバ関数

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

 

ヘッダー <filesystem> で定義
class directory_iterator;		(C++17以降)

directory_iterator は、ディレクトリのエントリ (ただしサブディレクトリは含まない) を走査する LegacyInputIterator です。走査順序は未規定ですが、各ディレクトリ エントリは一度だけ訪問されます。特殊なパス名である dot (カレントディレクトリ) と dot-dot (親ディレクトリ) はスキップされます。

directory_iterator がエラーを報告した場合、または最後のディレクトリ エントリを過ぎて進んだ場合、それはデフォルト構築されたイテレータ、すなわちエンド イテレータと等しくなります。2つのエンド イテレータは常に等しく、エンド イテレータのデリファレンスまたはインクリメントは未定義の動作です。

ディレクトリ イテレータが作成された後に、ファイルまたはディレクトリが削除されたり、ディレクトリ ツリーに追加されたりした場合、その変更がイテレータを通じて観測されるかどうかは未規定です。

メンバ型

メンバ型	定義
value_type	std::filesystem::directory_entry
difference_type	std::ptrdiff_t
pointer	const std::filesystem::directory_entry*
reference	const std::filesystem::directory_entry&
iterator_category	std::input_iterator_tag

メンバ関数

(コンストラクタ)	ディレクトリ イテレータを構築します (public member function)
(デストラクタ)	デフォルト デストラクタ (public member function)
operator=	内容を代入する (public member function)
operator*operator->	指しているエントリにアクセスします (public member function)
incrementoperator++	次のエントリに進みます (public member function)

非メンバ関数

begin(std::filesystem::directory_iterator)end(std::filesystem::directory_iterator) (C++17)

範囲ベース for ループのサポート (function)

さらに、operator== および operator!= は(C++20まで)operator== は(C++20以降) LegacyInputIterator で要求されるとおりに提供されます。

operator!= が提供されるかどうかは未規定です。これは operator== から合成できるためであり、また、等価演算子がメンバ関数か非メンバ関数かも未規定です。

ヘルパー特殊化

template<> constexpr bool     ranges::enable_borrowed_range<std::filesystem::directory_iterator> = true;		(C++20以降)
template<> constexpr bool     ranges::enable_view<std::filesystem::directory_iterator> = true;		(C++20以降)

これらの directory_iterator の特殊化により、それは borrowed_range および view になります。

注記

ディレクトリ走査のための多くの低レベル OS API は、次のディレクトリ エントリとともにファイル属性を取得します。std::filesystem::directory_iterator のコンストラクタおよび非 const メンバ関数は、これらの属性 (存在する場合) を、directory_entry::refresh を呼び出すことなく、指されている std::filesystem::directory_entry に格納します。これにより、追加のシステムコールを行わずに、イテレーション中にディレクトリ エントリの属性を検査することが可能になります。

例

このコードを実行

#include <algorithm>
#include <filesystem>
#include <fstream>
#include <iostream>
 
int main()
{
    const std::filesystem::path sandbox{"sandbox"};
    std::filesystem::create_directories(sandbox/"dir1"/"dir2");
    std::ofstream{sandbox/"file1.txt"};
    std::ofstream{sandbox/"file2.txt"};
 
    std::cout << "directory_iterator:\n";
    // directory_iterator can be iterated using a range-for loop
    for (auto const& dir_entry : std::filesystem::directory_iterator{sandbox}) 
        std::cout << dir_entry.path() << '\n';
 
    std::cout << "\ndirectory_iterator as a range:\n";
    // directory_iterator behaves as a range in other ways, too
    std::ranges::for_each(
        std::filesystem::directory_iterator{sandbox},
        [](const auto& dir_entry) { std::cout << dir_entry << '\n'; });
 
    std::cout << "\nrecursive_directory_iterator:\n";
    for (auto const& dir_entry : std::filesystem::recursive_directory_iterator{sandbox}) 
        std::cout << dir_entry << '\n';
 
    // delete the sandbox dir and all contents within it, including subdirs
    std::filesystem::remove_all(sandbox);
}

実行結果の例

directory_iterator:
"sandbox/file2.txt"
"sandbox/file1.txt"
"sandbox/dir1"
 
directory_iterator as a range:
"sandbox/file2.txt"
"sandbox/file1.txt"
"sandbox/dir1"
 
recursive_directory_iterator:
"sandbox/file2.txt"
"sandbox/file1.txt"
"sandbox/dir1"
"sandbox/dir1/dir2"

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 3480	C++20	directory_iterator は borrowed_range でも view でもなくなかった	両方である

関連項目

recursive_directory_iterator (C++17)	ディレクトリとそのサブディレクトリの内容を指すイテレータ (クラス)
directory_options (C++17)	ディレクトリの内容をイテレートするためのオプション (列挙型)
directory_entry (C++17)	ディレクトリエントリ (クラス)