home | help 
std::filesy...ory_iterator(3)  C++ Standard Libary std::filesy...ory_iterator(3)

NAME
     std::filesystem::recursive_directory_iterator::recursive_directory_iterator
     - std::filesystem::recursive_directory_iterator::recursive_directory_itera-
     tor

Synopsis
	recursive_directory_iterator()	noexcept;			     (1)
     (since C++17)
	recursive_directory_iterator( const  recursive_directory_iterator&   (2)
     (since C++17)
	other );
	recursive_directory_iterator(  recursive_directory_iterator&&  other (3)
     (since C++17)
	) noexcept;
	explicit recursive_directory_iterator(	const			     (4)
     (since C++17)
	std::filesystem::path& p );
	recursive_directory_iterator(

	    const  std::filesystem::path&  p,				     (5)
     (since C++17)

	    std::filesystem::directory_options options );
	recursive_directory_iterator(

	    const std::filesystem::path&  p,				     (6)
     (since C++17)
	    std::filesystem::directory_options options,

	    std::error_code& ec );
	recursive_directory_iterator(  const  std::filesystem::path& p,      (7)
     (since C++17)
	std::error_code& ec );

	Constructs new recursive directory iterator.

	1) Default constructor. Constructs an end iterator.
	2) Copy constructor.
	3) Move constructor.
	4-7) Constructs an iterator that refers to the first entry in the direc-
     tory that p
	resolves to.

	 This section is incomplete
	 Reason: errors

Parameters
	p	- path to the filesystem object to which the directory	iterator
     will refer
	ec	 -  out-parameter  for error reporting in the non-throwing over-
     loads
	options - the set of BitmaskType options that control  the  behavior  of
     the directory
		  iterator
	other	 - another directory iterator to use as source to initialize the
     directory
		  iterator with

Exceptions
	Any overload not marked noexcept may throw std::bad_alloc if memory  al-
     location
	fails.

	4,5)  Throws  std::filesystem::filesystem_error on underlying OS API er-
     rors,
	constructed with p as the first path argument and the OS error	code  as
     the error
	code argument.
	6,7) Sets a std::error_code& parameter to the OS API error code if an OS
     API call
	fails, and executes ec.clear() if no errors occur.

Notes
	Recursive  directory  iterators  do not follow directory symlinks by de-
     fault. To enable
	this behavior, specify directory_options::follow_directory_symlink among
     the options
	option set.

Example
	 This section is incomplete
	 Reason: no example

	Defect reports

	The following behavior-changing defect	reports  were  applied	retroac-
     tively to
	previously published C++ standards.

	   DR	 Applied to		 Behavior as published		    Cor-
     rect behavior
	LWG   3013  C++17	error_code  overload  marked  noexcept	but  can
     noexcept removed
			    allocate memory

Categories:
	  * Todo with reason
	  * Todo no example

http://cppreference.com 	   2024.06.10	   std::filesy...ory_iterator(3)
home | help