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"). POSIX filesystems have single root.
- 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 in normal form has no redundant current directory (dot) elements, no redundant parent directory (dot-dot) elements, and no redundant directory-separators. The normal form for an empty path is an empty path. The normal form for a path ending in a directory-separator that is not the root directory has a current directory (dot) element appended.
The path can be traversed element-wise via iterators returned by the begin() and end() functions, which 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 a file name dot.
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, all library functions accept path names in both formats.
Paths are implicitly convertible to and from std::basic_strings, which makes it possible to use them with over files APIs, e.g. as an argument to std::ifstream::open
Member types
| 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 BidirectionalIterator with a value_type of path
|
iterator
|
an alias to const_iterator
|
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 (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
| swaps two paths (function) | |
| calculates a hash value for a path object (function) | |
| lexicographically compares two paths (function) | |
| concatenates two paths with a directory separator (function) | |
| performs stream input and output on a path (function) | |
| (C++17) |
creates a path from a UTF-8 encoded source (function) |