std::filesystem::path
| Defined in header <filesystem>
|
||
| class path; |
(since C++17) | |
Objects of type path represent paths on a filesystem. Only syntactic aspects of paths are handled: the pathname may represent a non-existing path or even one that is not allowed to exist on the current file system or OS.
The path name has the following syntax:
- root-name(optional): identifies the root on a filesystem with multiple roots (such as "C:" or "//myserver"). In case of ambiguity, the longest sequence of characters that forms a valid root-name is treated as the root-name. The standard library may define additional root-names besides the ones understood by the OS API.
- root-directory(optional): a directory separator that, if present, marks this path as absolute. If it is missing (and the first element other than the root name is a file name), then the path is relative and requires another path as the starting location to resolve to a file name.
- Zero or more of the following:
- file-name: sequence of characters that aren't directory separators or preferred directory separators (additional limitations may be imposed by the OS or file system). This name may identify a file, a hard link, a symbolic link, or a directory. Two special file-names are recognized:
- dot: the file name consisting of a single dot character . is a directory name that refers to the current directory
- dot-dot: the file name consisting of two dot characters .. is a directory name that refers to the parent directory.
- directory-separators: the forward slash character / or the alternative character provided as
path::preferred_separator. If this character is repeated, it is treated as a single directory separator: /usr///////lib is the same as /usr/lib
A path can be normalized by following this algorithm:
- If the path is empty, stop (normal form of an empty path is an empty path)
- Replace each directory-separator (which may consist of multiple slashes) with a single
path::preferred_separator. - Replace each slash character in the root-name with
path::preferred_separator. - Remove each dot and any immediately following directory-separator.
- Remove each non-dot-dot filename immediately followed by a directory-separator and a dot-dot, along with any immediately following directory-separator.
- If there is root-directory, remove all dot-dots and any directory-separators immediately following them.
- If the last filename is dot-dot, remove any trailing directory-separator.
- If the path is empty, add a dot (normal form of ./ is .)
The path can be traversed element-wise via iterators returned by the begin() and end() functions, which views the path in generic format and iterates over root name, root directory, and the subsequent file name elements (directory separators are skipped except the one that identifies the root directory). If the very last element in the path is a directory separator, the last iterator will dereference to an empty element.
Calling any non-const member function of a path invalidates all iterators referring to elements of that object.
If the OS uses a native syntax that is different from the portable generic syntax described above, library functions that are defined to accept "detected format" accept path names in both formats: a detected format argument is taken to be in the generic format if and only if it matches the generic format but is not acceptable to the operating system as a native path. On those OS where native format differs between pathnames of directories and pathnames of files, a generic pathname is treated as a directory path if it ends on a directory separator and a regular file otherwise.
In any case, the path class behaves as if it stores a pathname in the native format and automatically converts to generic format as needed (each member function specifies which format it interprets the path as)
On POSIX systems, the generic format is the native format and there is no need to distinguish or convert between them.
Paths are implicitly convertible to and from std::basic_strings, which makes it possible to use them with other file APIs.
The stream operators use std::quoted so that spaces do not cause truncation when later read by stream input operator.
Decomposition member functions (e.g. extension) return filesystem::path objects instead of string objects as other APIs do.
Member types and constants
| Type | Definition | ||||||||
value_type
|
character type used by the native encoding of the filesystem: char on POSIX, wchar_t on Windows | ||||||||
string_type
|
std::basic_string<value_type> | ||||||||
const_iterator
|
a constant LegacyBidirectionalIterator with a value_type of path, except that for dereferenceable iterators a and b of type path::iterator with a == b, there is no requirement that *a and *b are bound to the same object
| ||||||||
iterator
|
an alias to const_iterator
| ||||||||
| determines how to interpret string representations of pathnames
The following enumerators are also defined:
(enum) |
Member constants
| constexpr value_type preferred_separator [static] |
alternative directory separator which may be used in addition to the portable /. On Windows, this is the backslash character \. On POSIX, this is the same forward slash / as the portable separator (public static member constant) |
Member functions
constructs a path (public member function) | |
destroys a path object (public member function) | |
| assigns another path (public member function) | |
| assigns contents (public member function) | |
Concatenation | |
| appends elements to the path with a directory separator (public member function) | |
| concatenates two paths without introducing a directory separator (public member function) | |
Modifiers | |
| erases the contents (public member function) | |
| converts directory separators to preferred directory separator (public member function) | |
| removes filename path component (public member function) | |
| replaces the last path component with another path (public member function) | |
| replaces the extension (public member function) | |
| swaps two paths (public member function) | |
Format observers | |
| returns the native version of the path (public member function) | |
| returns the path in native pathname format converted to a string (public member function) | |
| returns the path in generic pathname format converted to a string (public member function) | |
Compare | |
| compares the lexical representations of two paths lexicographically (public member function) | |
Generation | |
| converts path to normal form converts path to relative form converts path to proximate form (public member function) | |
Decomposition | |
| returns the root-name of the path, if present (public member function) | |
| returns the root directory of the path, if present (public member function) | |
| returns the root path of the path, if present (public member function) | |
| returns path relative to the root path (public member function) | |
| returns the path of the parent path (public member function) | |
| returns the filename path component (public member function) | |
| returns the stem path component (filename without the final extension) (public member function) | |
| returns the file extension path component (public member function) | |
Queries | |
| checks if the path is empty (public member function) | |
| checks if the corresponding path element is not empty (public member function) | |
| checks if root_path() uniquely identifies file system location (public member function) | |
Iterators | |
| iterator access to the path as a sequence of elements (public member function) | |
Non-member functions
| Defined in namespace
std::filesystem | |
| (C++17) |
swaps two paths (function) |
| calculates a hash value for a path object (function) | |
| (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20) |
lexicographically compares two paths (function) |
| concatenates two paths with a directory separator (function) | |
| performs stream input and output on a quoted path (function) | |
| (C++17)(deprecated in C++20) |
creates a path from a UTF-8 encoded source (function) |
Helper classes
| Defined in namespace
std | |
| hash support for std::filesystem::path (class template specialization) | |
Defect reports
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
| DR | Applied to | Behavior as published | Correct behavior |
|---|---|---|---|
| LWG 3657 | C++17 | hash for path was disabled
|
enabled |