STD::FILESYSTEM::RECURSIVE_DIRECTORY_ITERATOR(3)

📦
version 16.2.1+r23+gd564253eb6c8 · 7 versions
, in arch rolling, fedora 44

💖 NAME 💖

okay bestie, welcome to the whole entire vibe of std::filesystem::recursive_directory_iterator — it's literally the iterator type for recursively traversing a directory hierarchy. yes. all of it. every subfolder. every sub-subfolder. she goes deep. 🌸

this is straight out of the Library Functions Manual, so you know it's the real deal. 🫶

✨ SYNOPSIS ✨

#include <filesystem>

🎀 Public Types 🎀

  • typedef ptrdiff_t difference_type
  • typedef input_iterator_tag iterator_category
  • typedef const directory_entry * pointer
  • typedef const directory_entry & reference
  • typedef directory_entry value_type

🦋 Public Member Functions 🦋

  • recursive_directory_iterator (const path &__p)
  • recursive_directory_iterator (const path &__p, directory_options __options)
  • recursive_directory_iterator (const path &__p, directory_options __options, error_code &__ec)
  • recursive_directory_iterator (const path &__p, error_code &__ec)
  • recursive_directory_iterator (const recursive_directory_iterator &)=default
  • recursive_directory_iterator (recursive_directory_iterator &&)=default
  • int depth () const noexcept
  • void disable_recursion_pending () noexcept
  • recursive_directory_iterator & increment (error_code &__ec)
  • const directory_entry & operator* () const noexcept
  • recursive_directory_iterator & operator++ ()
  • __directory_iterator_proxy operator++ (int)
  • const directory_entry * operator-> () const noexcept
  • recursive_directory_iterator & operator= (const recursive_directory_iterator &__rhs) noexcept
  • recursive_directory_iterator & operator= (recursive_directory_iterator &&__rhs) noexcept
  • bool operator== (default_sentinel_t) const noexcept
  • directory_options options () const noexcept
  • void pop ()
  • void pop (error_code &)
  • bool recursion_pending () const noexcept

💜 Friends 💜

  • uintmax_t filesystem::remove_all (const path &)
  • uintmax_t filesystem::remove_all (const path &, error_code &)
  • bool operator== (const recursive_directory_iterator &__lhs, const recursive_directory_iterator &__rhs) noexcept

🌈 DETAILED DESCRIPTION 🌈

Iterator type for recursively traversing a directory hierarchy.

⭐ Since ⭐

C++17

(so she's been iconic since C++17, no cap 💅)

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code.

that's the whole page bestie, every flag, every overload, every noexcept — nothing skipped, nothing invented, fr fr. 🍓

later, legend — this was libstdc++'s very own std::files...ry_iterator(3) page, and now you're basically an expert. go traverse something recursively (respectfully). 🧚💖

📦 where this page comes from
  • arch rolling: gcc 16.2.1+r23+gd564253eb6c8-1 · GPL-3.0-or-later WITH GCC-exception-3.1 AND GFDL-1.3-or-later
  • fedora 44: libstdc++-docs 16.0.1-0.10.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • fedora 44: libstdc++-docs 16.2.1-2.fc44
  • fedora 44: libstdc++-docs 16.2.1-3.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms