Section 3: library functions
std::filesystem::file_type – std::filesystem::file_type Synopsis Defined in header <filesystem> enum class file_type { none = /* unspecified */, not_found = /* unspecified */, regular = /* unspecified */, directory = /* unspecified */, symlink = /* unspecified */, block = /* unspecified */, (since C++17) character = /* unspecified */, fifo = /* unspecified */, socket…
std::filesystem::file_time_type – std::filesystem::file_time_type Synopsis Defined in header <filesystem> using file_time_type = std::chrono::time_point</*trivial-clock*/>; (since C++17) (until C++20) using file_time_type = std::chrono::time_point<std::chrono::file_clock>; (since C++20) Represents file time. trivial-clock is an implementation-defined type that satisfies TrivialClock and is sufficient to represent the resolution and range of the file time values offered by the filesystem. (until C++20) Example //…
std::filesystem::file_status::type – std::filesystem::file_status::type Synopsis std::filesystem::file_type type() const noexcept; (1) (since C++17) void type( std::filesystem::file_type type ) noexcept; (2) (since C++17) Accesses the file type information. 1) Returns file type information. 2) Sets file type to type. Parameters type – file type to set to Return value 1) File type information. 2) (none) Example This section…
std::filesystem::file_status::permissions – std::filesystem::file_status::permissions Synopsis std::filesystem::perms permissions() const noexcept; (1) (since C++17) void permissions( std::filesystem::perms perm ) noexcept; (2) (since C++17) Accesses the file permissions information. 1) Returns file permissions information. 2) Sets file permissions to perm. Parameters perm – file permissions to set to Return value 1) File permissions information. 2) (none) Example This section…
std::filesystem::file_status::operator= – std::filesystem::file_status::operator= Synopsis file_status &operator=(const file_status &other) noexcept = default; (1)(since C++ 17) file_status & operator=(file_status &&other) noexcept = default; (2)(since C++ 17) Copy- or move-assigns another file status object. Parameters other – another file_status object to assign Return value *this Example This section is incomplete Reason: no example
std::filesystem::file_status::file_status – std::filesystem::file_status::file_status Synopsis file_status() noexcept : file_status(std::filesystem::file_type::none){}(1)(since C++ 17) file_status(const file_status &) noexcept = default; (2)(since C++ 17) file_status(file_status &&) noexcept = default; (3)(since C++ 17) explicit file_status( std::filesystem::file_type type, (4)(since C++ 17) std::filesystem::perms permissions = std::filesystem::perms::unknown) noexcept; Constructs a new file_status object. 1) Default constructor that calls (4) with std::filesystem::file_type::none. 2-3) Copy and…
std::filesystem::file_status – std::filesystem::file_status Synopsis Defined in header <filesystem> class file_status; (since C++17) Stores information about the type and permissions of a file. Member functions constructs a file_status object constructor (public member function) assigns contents operator= (public member function) implicit destructor destructor (public member function) gets or sets the type of the file type (public member…
std::filesystem::file_size – std::filesystem::file_size Synopsis Defined in header<filesystem> std::uintmax_t file_size(const std::filesystem::path &p); std::uintmax_t file_size(const std::filesystem::path &p, (1)(since C++ 17) std::error_code &ec) noexcept; If p does not exist, reports an error. For a regular file p, returns the size determined as if by reading the st_size member of the structure obtained by POSIX stat (symlinks are followed)…
std::filesystem::exists – std::filesystem::exists Synopsis Defined in header<filesystem> bool exists(std::filesystem::file_status s) noexcept; (1)(since C++ 17) bool exists(const std::filesystem::path &p); (2)(since C++ 17) bool exists(const std::filesystem::path &p, std::error_code &ec) noexcept; Checks if the given file status or path corresponds to an existing file or directory. 1) Equivalent to status_known(s) && s.type() != file_type::not_found. 2) Let s be…
std::filesystem::equivalent – std::filesystem::equivalent Synopsis Defined in header<filesystem> bool equivalent(const std::filesystem::path &p1, const std::filesystem::path &p2); bool equivalent(const std::filesystem::path &p1, (1)(since C++ 17) const std::filesystem::path &p2, std::error_code &ec) noexcept; Checks whether the paths p1 and p2 resolve to the same file system entity. If either p1 or p2 does not exist, an error is reported. The non-throwing…
std::filesystem::directory_options – std::filesystem::directory_options Synopsis Defined in header <filesystem> enum class directory_options { none = /* unspecified */, follow_directory_symlink = /* unspecified */, (since C++17) skip_permission_denied = /* unspecified */ }; This type represents available options that control the behavior of the directory_iterator and recursive_directory_iterator. directory_options satisfies the requirements of BitmaskType (which means the bitwise operators…
std::filesystem::directory_iterator::operator= – std::filesystem::directory_iterator::operator= Synopsis directory_iterator &operator=(const directory_iterator &) = default; (since C++ 17) directory_iterator & operator=(directory_iterator &&) = default; This section is incomplete Parameters This section is incomplete Return value *this Exceptions This section is incomplete
std::filesystem::directory_iterator::operator*,std::filesystem::directory_iterator::operator-> – std::filesystem::directory_iterator::operator*,std::filesystem::directory_iterator::operator-> Synopsis const directory_entry &operator*() const; (since C++ 17) const directory_entry * operator->() const; Accesses the pointed-to directory_entry. The result of operator* or operator-> on the end iterator is undefined behavior. Parameters (none) Return value 1) Value of the directory_entry referred to by this iterator 2) Pointer to the directory_entry referred to by…
std::filesystem::directory_iterator::directory_iterator – std::filesystem::directory_iterator::directory_iterator Synopsis directory_iterator() noexcept; (1)(since C++ 17) explicit directory_iterator(const std::filesystem::path &p); (2)(since C++ 17) directory_iterator(const std::filesystem::path &p, (3)(since C++ 17) std::filesystem::directory_options options); directory_iterator(const std::filesystem::path &p, std::error_code &ec); (4)(since C++ 17) directory_iterator(const std::filesystem::path &p, std::filesystem::directory_options options, (5)(since C++ 17) std::error_code &ec); directory_iterator(const directory_iterator &) = default; (6)(since C++ 17) directory_iterator(directory_iterator &&) = default; (7)(since…
std::filesystem::directory_iterator – std::filesystem::directory_iterator Synopsis Defined in header <filesystem> class directory_iterator; (since C++17) directory_iterator is a LegacyInputIterator that iterates over the directory_entry elements of a directory (but does not visit the subdirectories). The iteration order is unspecified, except that each directory entry is visited only once. The special pathnames dot and dot-dot are skipped. If the…
std::filesystem::directory_entry::status,std::filesystem::directory_entry::symlink_status – std::filesystem::directory_entry::status,std::filesystem::directory_entry::symlink_status Synopsis std::filesystem::file_status status() const; (1)(since C++ 17) std::filesystem::file_status status(std::error_code &ec) const noexcept; std::filesystem::file_status symlink_status() const; (2)(since C++ 17) std::filesystem::file_status symlink_status(std::error_code &ec) const noexcept; 1) Returns status of the entry, as if determined by a status call (symlinks are followed to their targets) 2) Returns status of the entry, as if determined by…
std::filesystem::directory_entry::replace_filename – std::filesystem::directory_entry::replace_filename Synopsis void replace_filename(const std::filesystem::path &p); (since C++ 17) void replace_filename(const std::filesystem::path &p, std::error_code &ec); Changes the filename of the directory entry. Effectively modifies the path member by path.replace_filename(p) and calls refresh to update the cached attributes. If an error occurs, the values of the cached attributes are unspecified. This function does not…
std::filesystem::directory_entry::refresh – std::filesystem::directory_entry::refresh Synopsis void refresh(); (since C++ 17) void refresh(std::error_code &ec) noexcept; Examines the filesystem object referred to by this directory entry and stores its attributes for retrieval with status(), exists(), is_regular_file(), and other status accessors. If an error occurs, the value of any cached attributes is unspecified Parameters ec – out-parameter for error…
std::filesystem::directory_entry::path – std::filesystem::directory_entry::path Synopsis const std::filesystem::path &path() const noexcept; (since C++ 17) operator const std::filesystem::path &() const noexcept; (since C++ 17) Returns the full path the directory entry refers to. Parameters (none) Return value The full path the directory entry refers to. Example This section is incomplete Reason: no example See also This section is…
std::filesystem::directory_entry::operator==,!=,<,<=,>,>= – std::filesystem::directory_entry::operator==,!=,<,<=,>,>= Synopsis bool operator==( const directory_entry& rhs ) const noexcept; (1) (since C++17) bool operator!=( const directory_entry& rhs ) const noexcept; (2) (since C++17) bool operator<( const directory_entry& rhs ) const noexcept; (3) (since C++17) bool operator<=( const directory_entry& rhs ) const noexcept; (4) (since C++17) bool operator>( const directory_entry& rhs ) const…