Section 3: library functions
std::experimental::filesystem::filesystem_error::what – std::experimental::filesystem::filesystem_error::what Synopsis const char *what() const; (filesystem TS) Returns the explanatory byte string that was stored in the exception object. Parameters (none) Exceptions noexcept specification: noexcept See also This section is incomplete
std::experimental::filesystem::filesystem_error::path1,path2 – std::experimental::filesystem::filesystem_error::path1,path2 Synopsis const path &path1() const; (filesystem TS) const path &path2() const; (filesystem TS) Returns the paths that were stored in the exception object. Parameters (none) Exceptions noexcept specification: noexcept See also This section is incomplete
std::experimental::filesystem::filesystem_error::filesystem_error – std::experimental::filesystem::filesystem_error::filesystem_error Synopsis filesystem_error( const string& what_arg, error_code ec ); (1) (filesystem TS) filesystem_error( const string& what_arg, const path& p1, error_code ec ); (2) (filesystem TS) filesystem_error( const string& what_arg, const path& p1, const path& p2, error_code ec ); (3) (filesystem TS) Constructs a new filesystem error object. The explanatory string is set to…
std::experimental::filesystem::filesystem_error – std::experimental::filesystem::filesystem_error Synopsis Defined in header <experimental/filesystem> class filesystem_error; (filesystem TS) An exception type thrown when errors are encountered. std-experimental-filesystem-filesystem error-inheritance.svg Inheritance diagram Member functions constructs the error object constructor (public member function) returns the paths that were involved in the operation that caused the error path1 (public member function) path2 returns the explanatory…
std::experimental::filesystem::file_type – std::experimental::filesystem::file_type Synopsis Defined in header <experimental/filesystem> enum class file_type { none = 0, not_found = -1, regular = 1, directory = 2, symlink = 3, (filesystem TS) block = 4, character = 5, fifo = 6, socket = 7, unknown = 8 }; Indicates a type of a file or directory a path…
std::experimental::filesystem::file_time_type – std::experimental::filesystem::file_time_type Synopsis Defined in header <experimental/filesystem> using file_time_type = chrono::time_point</*trivial-clock*/>; (filesystem TS) 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. Example // Run this code #include <iostream> #include <chrono> #include <iomanip> #include…
std::experimental::filesystem::file_status::type – std::experimental::filesystem::file_status::type Synopsis file_type type() const; (1) (filesystem TS) void type( file_type type ); (2) (filesystem TS) 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) Exceptions noexcept specification: noexcept
std::experimental::filesystem::file_status::permissions – std::experimental::filesystem::file_status::permissions Synopsis perms permissions() const; (1) (filesystem TS) void permissions( perms perm ); (2) (filesystem TS) Accesses the file permissions information. 1) Returns file permissions information. 2) Sets file type to perm. Parameters perm – file permissions to set to Return value 1) File permissions information. 2) (none) Exceptions noexcept specification: noexcept
std::experimental::filesystem::file_status::operator= – std::experimental::filesystem::file_status::operator= Synopsis file_status &operator=(const file_status &other) = default; (1)(filesystem TS) file_status & operator=(file_status &&other) = default; (2)(filesystem TS) Copy- or move-assigns another file type object. Parameters This section is incomplete Return value *this Exceptions noexcept specification: noexcept
std::experimental::filesystem::file_status::file_status – std::experimental::filesystem::file_status::file_status Synopsis file_status(const file_status &) = default; (1)(filesystem TS) file_status(file_status &&) = default; (2)(filesystem TS) explicit file_status(file_type type = file_type::none, (3)(filesystem TS) perms permissions = perms::unknown); Constructs a new file_status object. 1) Default copy constructor. 2) Default move constructor. 3) Initializes the file status object with type as type and permissions as permissions….
std::experimental::filesystem::file_status – std::experimental::filesystem::file_status Synopsis Defined in header <experimental/filesystem> class file_status; (filesystem TS) 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::experimental::filesystem::file_size – std::experimental::filesystem::file_size Synopsis Defined in header<experimental / filesystem> std::uintmax_t file_size(const path &p); (1)(filesystem TS) std::uintmax_t file_size(const path &p, error_code &ec); Returns the size of the regular file p, determined as if by reading the st_size member of the structure obtained by POSIX stat (symlinks are followed) Attempting to determine the size of a directory…
std::experimental::filesystem::exists – std::experimental::filesystem::exists Synopsis Defined in header <experimental/filesystem> bool exists( file_status s ) (1) (filesystem TS) bool exists( const path& p ); (2) (filesystem TS) bool exists( const path& p, error_code& ec ) Checks if the given file status or path corresponds to an existing file or directory. 1) Equivalent to status_known(s) && s.type() !=…
std::experimental::filesystem::equivalent – std::experimental::filesystem::equivalent Synopsis Defined in header<experimental / filesystem> bool equivalent(const path &p1, const path &p2); (1)(filesystem TS) bool equivalent(const path &p1, const path &p2, error_code &ec); Checks whether the paths p1 and p2 refer to the same file or directory and have the same file status as determined by status (symlinks are followed). If…
std::experimental::filesystem::directory_options – std::experimental::filesystem::directory_options Synopsis Defined in header <experimental/filesystem> enum class directory_options { none, follow_directory_symlink, (filesystem TS) skip_permission_denied }; 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 operator&, operator|, operator^, operator~, operator&=, operator|=, and operator^= are defined for this…
std::experimental::filesystem::directory_iterator::operator= – std::experimental::filesystem::directory_iterator::operator= Synopsis directory_iterator& operator++(); (filesystem TS) directory_iterator& increment( error_code& ec ) noexcept; Advances the iterator to the next entry. This section is incomplete Parameters ec – error code to store error status to Return value *this Exceptions 1) This section is incomplete 2) noexcept specification: noexcept
std::experimental::filesystem::directory_iterator::operator*,operator-> – std::experimental::filesystem::directory_iterator::operator*,operator-> Synopsis const directory_entry &operator*() const; (filesystem TS) 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 this…
std::experimental::filesystem::directory_iterator::directory_iterator – std::experimental::filesystem::directory_iterator::directory_iterator Synopsis directory_iterator(); (1)(filesystem TS) explicit directory_iterator(const path &p); (2)(filesystem TS) directory_iterator(const path &p, error_code &ec); (3)(filesystem TS) directory_iterator(const directory_iterator &) = default; (4)(filesystem TS) directory_iterator(directory_iterator &&) = default; (5)(filesystem TS) Constructs a new directory iterator. 1) Constructs the end iterator. 2) Constructs a directory iterator that refers to the first directory entry…
std::experimental::filesystem::directory_iterator – std::experimental::filesystem::directory_iterator Synopsis Defined in header <experimental/filesystem> class directory_iterator; (filesystem TS) directory_iterator is an 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::experimental::filesystem::directory_entry::status,std::experimental::filesystem::directory_entry::symlink_status – std::experimental::filesystem::directory_entry::status,std::experimental::filesystem::directory_entry::symlink_status Synopsis file_status status() const; (1)(filesystem TS) file_status status(error_code &ec) const; file_status symlink_status() const; (2)(filesystem TS) file_status symlink_status(error_code &ec) const; 1) Returns the potentially cached status of the entry, as if determined by a status call (symlinks are followed to their targets) 2) Returns the potentially cached status of the entry, as if…