Section 3: library functions
std::filesystem::path::replace_extension – std::filesystem::path::replace_extension Synopsis path &replace_extension(const path &replacement = path()); (1)(since C++ 17) Replaces the extension with replacement or removes it when the default value of replacement is used. Firstly, if this path has an extension(), it is removed from the generic – format view of the pathname. Then, a dot character is appended to…
std::filesystem::path::remove_filename – std::filesystem::path::remove_filename Synopsis path& remove_filename() (1) (since C++17) Removes a single generic-format filename component (as returned by filename) from the given generic-format path. After this function completes, has_filename returns false. Parameters (none) Return value *this Exceptions (none) Example // Run this code #include <iostream> #include <filesystem> namespace fs = std::filesystem; int main() { std::cout…
std::filesystem::path::relative_path – std::filesystem::path::relative_path Synopsis path relative_path() const; (since C++17) Returns path relative to root-path, that is, a pathname composed of every generic-format component of *this after root-path. If *this is an empty path, returns an empty path. Parameters (none) Return value Path relative to the root_path. Exceptions (none) Examples // Run this code #include <iostream>…
std::filesystem::path::~path – std::filesystem::path::~path Synopsis ~path(); (since C++17) Destroys the path object.
std::filesystem::path::parent_path – std::filesystem::path::parent_path Synopsis path parent_path() const; (since C++17) Returns the path to the parent directory. If has_relative_path() returns false, the result is a copy of *this Otherwise, the result is a path whose generic format pathname is the longest prefix of the generic format pathname of *this that produces one fewer element in its…
std::filesystem::path::operator= – std::filesystem::path::operator= Synopsis path &operator=(const path &p); (1)(since C++ 17) path & operator=(path &&p) noexcept; (2)(since C++ 17) path & operator=(string_type &&source); (3)(since C++ 17) template <class Source> (4)(since C++ 17) path & operator=(const Source &source); 1) Replaces the contents of *this with a pathname whose both native and generic format representations equal those…
std::filesystem::path::make_preferred – std::filesystem::path::make_preferred Synopsis path& make_preferred() (1) (since C++17) Converts all directory separators in the generic-format view of the path to the preferred directory separator. For example, on Windows, where \ is the preferred separator, the path foo/bar will be converted to fooar. Parameters (none) Return value *this Exceptions (none) Example This section is incomplete…
std::filesystem::path::lexically_normal,std::filesystem::path::lexically_relative,std::filesystem::path::lexically_proximate – std::filesystem::path::lexically_normal,std::filesystem::path::lexically_relative,std::filesystem::path::lexically_proximate Synopsis path lexically_normal() const; (1) (since C++17) path lexically_relative(const path& base) const; (2) (since C++17) path lexically_proximate(const path& base) const; (3) (since C++17) 1) Returns *this converted to normal_form in its generic format 2) Returns *this made relative to base. *First, if root_name () != base.root_name() || is_absolute() != base.is_absolute() || (!has_root_directory()…
std::filesystem::path::lexically_normal,std::filesystem::path::lexically_relative, – std::filesystem::path::lexically_normal,std::filesystem::path::lexically_relative, Synopsis path lexically_normal() const; (1) (since C++17) path lexically_relative(const path& base) const; (2) (since C++17) path lexically_proximate(const path& base) const; (3) (since C++17) 1) Returns *this converted to normal form in its generic format 2) Returns *this made relative to base. *First, if root_name () != base.root_name() || is_absolute() != base.is_absolute() || (!has_root_directory() && base.has_root_directory()), returns a default – constructed path. *Otherwise, first determines the first mismatched…
std::filesystem::path::is_absolute,is_relative – std::filesystem::path::is_absolute,is_relative Synopsis bool is_absolute() const; (1) (since C++17) bool is_relative() const; (2) (since C++17) Checks whether the path is absolute or relative. An absolute path is a path that unambiguously identifies the location of a file without reference to an additional starting location. The first version returns true if the path, in native…
std::filesystem::path::has_root_path,std::filesystem::path::has_root_name, – std::filesystem::path::has_root_path,std::filesystem::path::has_root_name, Synopsis std::filesystem::path::has_parent_path, std::filesystem::path::has_filename, std::filesystem::path::has_stem, std::filesystem::path::has_extension bool has_root_path() const; (1) (since C++17) bool has_root_name() const; (2) (since C++17) bool has_root_directory() const; (3) (since C++17) bool has_relative_path() const; (4) (since C++17) bool has_parent_path() const; (5) (since C++17) bool has_filename() const; (6) (since C++17) bool has_stem() const; (7) (since C++17) bool has_extension() const; (8) (since C++17) Checks whether the path contains the corresponding path element. 1) Checks whether root_path() is empty. 2) Checks whether root_name() is empty. 3) Checks whether root_directory() is empty. 4) Checks whether…
std::filesystem::path::generic_string,std::filesystem::path::generic_wstring, – std::filesystem::path::generic_string,std::filesystem::path::generic_wstring, Synopsis std::filesystem::path::generic_u32string template <class CharT, class Traits = std::char_traits<CharT>, (since class Alloc = std::allocator<CharT> > (1)C++ 17) std::basic_string<CharT, Traits, Alloc> generic_string(const Alloc &a = Alloc()) const; std::string generic_string() const; std::wstring generic_wstring() const; std::u16string generic_u16string() const; std::u32string generic_u32string() const; (2)(since(since std::string generic_u8string() const; C++ 17) C++ 17)(3)(until C++ 20) std::u8string generic_u8string() const; (since…
std::filesystem::path::format – std::filesystem::path::format Synopsis enum format { native_format, generic_format, (since C++17) auto_format }; Determines how string representations of pathnames are interpreted by the constructors of std::filesystem::path that accept strings. Constants Defined in header <filesystem> Value Explanation native_format Native pathname format generic_format Generic pathname format auto_format Implementation-defined pathname format, auto-detected where possible Notes On POSIX systems,…
std::filesystem::path::filename – std::filesystem::path::filename Synopsis path filename() const; (since C++17) Returns the generic-format filename component of the path. Equivalent to relative_path().empty() ? path() : *–end(). Parameters (none) Return value The filename identified by the path. Exceptions (none) Example // Run this code #include <iostream> #include <filesystem> namespace fs = std::filesystem; int main() { std::cout << fs::path("/foo/bar.txt").filename()…
std::filesystem::path::extension – std::filesystem::path::extension Synopsis path extension() const; (since C++17) Returns the extension of the filename component of the generic-format view of *this. If the filename() component of the generic-format path contains a period (.), and is not one of the special filesystem elements dot or dot-dot, then the extension is the substring beginning at the…
std::filesystem::path::empty – std::filesystem::path::empty Synopsis bool empty() const noexcept; (since C++17) (until C++20) [[nodiscard]] bool empty() const noexcept; (since C++20) Checks if the path in generic format is empty. Parameters (none) Return value true if the path is empty, false otherwise. Notes An empty path can be obtained by calling clear and by default-constructing a path….
std::filesystem::path::concat,std::filesystem::path::operator+= – std::filesystem::path::concat,std::filesystem::path::operator+= Synopsis path &operator+=(const path &p); (1)(since C++ 17) path & operator+=(const string_type &str); (2)(since C++ 17) path & operator+=(std::basic_string_view<value_type> str); path &operator+=(const value_type *ptr); (3)(since C++ 17) path & operator+=(value_type x); (4)(since C++ 17) template <class Source> (5)(since C++ 17) path & operator+=(const Source &source); template <class CharT> (6)(since C++ 17) path…
std::filesystem::path::compare – std::filesystem::path::compare Synopsis int compare(const path &p) const noexcept; (1)(since C++ 17) int compare(const string_type &str) const; (2)(since C++ 17) int compare(std::basic_string_view<value_type> str) const; int compare(const value_type *s) const; (3)(since C++ 17) Compares the lexical representations of the path and another path. 1) If root_name().native().compare(p.root_name().native()) is nonzero, returns that value. Otherwise, if has_root_directory() !=…
std::filesystem::path::clear – std::filesystem::path::clear Synopsis void clear() noexcept; (since C++ 17) Clears the stored pathname. empty() is true after the call. Parameters (none) Return value (none)
std::filesystem::path::c_str,std::filesystem::path::native,std::filesystem::path::operatorstring_type() – std::filesystem::path::c_str,std::filesystem::path::native,std::filesystem::path::operatorstring_type() Synopsis const value_type *c_str() const noexcept; (1)(since C++ 17) const string_type &native() const noexcept; (2)(since C++ 17) operator string_type() const; (3)(since C++ 17) Accesses the native path name as a character string. 1) Equivalent to native().c_str(). 2) Returns the native-format representation of the pathname by reference. 3) Returns the native-format representation of…