std::experi...++,increment(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸ’– NAME πŸ’–

hiii bestie welcome to the manual page for std::experimental::filesystem::recursive_directory_iterator::operator++,increment β€” from the C++ Standard Libary manual. The header title is std::experi...++,increment(3), and yes, the name is a whole mouthful. The original literally repeats it, so here are both name lines:

  • std::experimental::filesystem::recursive_directory_iterator::operator++,increment
  • -
  • std::experimental::filesystem::recursive_directory_iterator::operator++,increment

πŸ¦‹ Synopsis πŸ¦‹

here's the function-signature tea, with (filesystem TS) exactly where it belongs:

recursive_directory_iterator& operator++();
(filesystem TS)
recursive_directory_iterator& increment( error_code& ec );
(filesystem TS)

okay so what does it even do? It advances the iterator to the next entry. that's the main-character move. ✨

If there are no more entries left in the currently iterated directory, the iteration is resumed over the parent directory. The process is repeated if the parent directory has no sibling entries that can to be iterated on. If the parent of the directory hierarchy that has been recursively iterated on is reached β€” meaning there are no candidate entries at depth() == 0 β€” then *this is set to an end iterator. periodt. πŸ’…

Otherwise, if *this refers to a directory, it is iterated into if the following conditions are met:

  • disable_recursion_pending() has not been called before this increment, i.e. recursion_pending() == true.
  • The directory is not a symlink or following symlinks is enabled, i.e.
!is_symlink(this->symlink_status()) ||
    (options() & directory_options::follow_directory_symlink) != 0).

πŸŽ€ Parameters πŸŽ€

  • ec β€” error code to store the error status to.

🌸 Return value 🌸

*this β€” yes bestie, it hands you back *this. 🫢


πŸ”₯ Exceptions πŸ”₯

  1. filesystem_error if an error occurs. The error code is set to an appropriate error code for the error that caused the failure.
  2. noexcept specification: noexcept

πŸ‘‘ Categories πŸ‘‘

  • Noindexed pages
  • unconditionally noexcept

πŸ™ˆ Hidden categories πŸ™ˆ

  • Pages with unreviewed unconditional noexcept template
  • Pages with unreviewed noexcept template

mwah πŸ’‹ this page came from http://cppreference.com, dated 2024.06.10, and the footer title again is std::experi...++,increment(3). stay slay, bestie 🫢✨

πŸ“¦ where this page comes from