std::experimental::filesystem::path

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Filesystem library

Template:cpp/experimental/fs/navbar content

 

path

Template:cpp/experimental/fs/path/navbar content

 

Defined in header <experimental/filesystem>
class path;		(filesystem TS)

Objects of type path represent a path. Only syntactic aspects of paths are handled: the pathname may represent a non-existing path or even one that is not allowed on the current operating or file system.

The path can be traversed element-wise via iterators returned by the begin() and end() functions.

Calling any non-const member function of a path invalidates all iterators referring to elements of that object.

The forward traversal is done in the following order:

• The root name element, if any
• The root directory element, if any. The element is presented in generic format, thus lexicographical comparisons work correctly.
• Each successive filename element.
• . if one or mare trailing non-root / characters are present.

Member types

Type	Definition
value_type	todo
string_type	std::basic_string<value_type>
iterator	a constant BidirectionalIterator with a value_type of path
const_iterator	todo

Member constants

constexpr value_type preferred_separator [static]

todo (public static member constant)

Member functions

(constructor)	constructs a path (public member function)
(destructor)	destroys a path object (public member function)
operator=	assigns another path (public member function)
assign	assigns contents (public member function)
Concatenation
appendoperator/=	appends elements to the path (public member function)
concatoperator+=	concatenates two paths (public member function)
Modifiers
clear	erases the contents (public member function)
make_preferred	converts directory separators to preferred directory separator (public member function)
remove_filename	removes filename path component (public member function)
replace_filename	replaces the last path component with another path (public member function)
replace_extension	replaces the extension (public member function)
swap	swaps two paths (public member function)
Format observers
nativeoperator string_type	returns the native version of the path (public member function)
c_str	returns the native version of the path (public member function)
stringwstringu8stringu16stringu32string	returns the path in native pathname format converted to a string (public member function)
generic_stringgeneric_wstringgeneric_u8stringgeneric_u16stringgeneric_u32string	returns the path in generic pathname format converted to a string (public member function)
Compare
compare	compares the lexical representations of two paths lexicographically (public member function)
Decomposition
root_name	returns the root-name of the path, if present (public member function)
root_directory	returns the root directory of the path, if present (public member function)
root_path	returns the root path of the path, if present (public member function)
relative_path	returns path relative to the root path (public member function)
parent_path	returns the path of the parent path (public member function)
filename	returns the filename path component (public member function)
stem	returns the stem path component (public member function)
extension	returns the file extension path component (public member function)
Queries
empty	checks if the path is empty (public member function)
has_root_pathhas_root_namehas_root_directoryhas_relative_pathhas_parent_pathhas_filenamehas_stemhas_extension	checks if the corresponding path element is not empty (public member function)
is_absoluteis_relative	checks if root_path() uniquely identifies file system location (public member function)
Iterators
begin	returns an iterator to the beginning of element list (public member function)
end	returns an iterator to the end of element list (public member function)

Non-member functions

swap(std::fs::path)	swaps two paths (function)
operator==operator!=operator<operator<=operator>operator>=	lexicographically compares two paths (function)
operator/	concatenates two paths (function)
operator<<operator>>	performs stream input and output on a path (function)
u8path	creates a path from a UTF-8 encoded source (function)