Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

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

NAME
       std::filesystem::directory_entry::is_directory  -  std::filesystem::di-
       rectory_entry::is_directory

Synopsis
	  bool	is_directory()	const;					(since
       C++17)
	  bool is_directory( std::error_code& ec ) const noexcept;

	  Checks whether the pointed-to	object is a directory. Effectively re-
       turns
	  std::filesystem::is_directory(status()) or
	  std::filesystem::is_directory(status(ec)), respectively.

Parameters
	  ec - out-parameter for error reporting in the	non-throwing overload

Return value
	  true if the referred-to filesystem object is a directory, false oth-
       erwise.

Exceptions
	  The overload that does not take a std::error_code& parameter throws
	  filesystem::filesystem_error	on  underlying	OS  API	 errors,  con-
       structed	with p as the
	  first	path argument and the OS error code as the  error  code	 argu-
       ment. The overload
	  taking a std::error_code& parameter sets it to the OS	API error code
       if an OS	API
	  call fails, and executes ec.clear() if no errors occur. Any overload
       not marked
	  noexcept may throw std::bad_alloc if memory allocation fails.

Example
       // Run this code

	#include <iostream>
	#include <filesystem>

	namespace fs = std::filesystem;

	int main()
	{
	    fs::directory_entry	d1(".");
	    fs::directory_entry	d2("file.txt");
	    fs::directory_entry	d3("new_dir");

	    std::cout << std::boolalpha
		      << ". d1 " << d1.is_directory() << '\n'
		      << "file.txt d2 "	<< d2.is_directory() <<	'\n'
		      // false because it has not been created
		      << "new_dir d3 " << d3.is_directory() << '\n';

	    fs::create_directory("new_dir");

	    std::cout  << "new_dir d3 before refresh " << d3.is_directory() <<
       '\n';
	    d3.refresh();
	    std::cout << "new_dir d3 after refresh " <<	 d3.is_directory()  <<
       '\n';
	}

Possible output:
	. d1 true
	file.txt d2 false
	new_dir	d3 false
	new_dir	d3 before refresh false
	new_dir	d3 after refresh true

See also
	  is_directory checks whether the given	path refers to a directory
	  (C++17)      (function)

http://cppreference.com		  2022.07.31	  std::filesy...s_directory(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=std::filesystem::directory_entry::is_directory&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help