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)

Technical Specifications

 

Technical specifications

Filesystem library (filesystem TS)

Library fundamentals (library fundamentals TS)

Library fundamentals 2 (library fundamentals 2 TS)

Extensions for parallelism (parallelism TS)

Concepts (concepts TS)

Extensions for concurrency (concurrency TS)

 

Filesystem library

Classes
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator filesystem::file_status	filesystem::space_info filesystem::file_type filesystem::perms filesystem::copy_options filesystem::directory_options filesystem::file_time_type
Functions
filesystem::absolute filesystem::system_complete filesystem::canonical filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path filesystem::exists filesystem::equivalent	filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status filesystem::temp_directory_path
File types
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

 

path

Member functions
path::path path::~path path::operator= path::assign path::appendoperator /= path::concatoperator += path::clear path::make_preferred path::remove_filename path::replace_filename path::replace_extension path::swap path::compare	path::c_strpath::nativeoperator string_type path::stringpath::u8stringpath::u16stringpath::u32stringpath::wstring path::generic_stringpath::generic_u8stringpath::generic_u16stringpath::generic_u32stringpath::generic_wstring path::beginpath::end
Path decomposition
path::root_name path::root_directory path::root_path path::relative_path path::parent_path path::filename path::stem path::extension path::empty	path::has_root_pathpath::has_root_namepath::has_root_directorypath::has_relative_pathpath::has_parent_pathpath::has_filenamepath::has_stempath::has_extension path::is_absolutepath::is_relative
Non-member functions
swap(path)
operator==operator!=operator<operator<=operator>operator>=
operator/
operator<<operator>>
u8path

 

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

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:

1. root-name(optional): identifies the root on a filesystem with multiple roots (such as "C:" or "//myserver". POSIX filesystems have single root.
2. 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)
3. 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

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

(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 without introducing a directory separator (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
c_strnativeoperator string_type	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
beginend	iterator access to the path as a sequence of elements (public member function)

Non-member functions

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