.TH "std::experimental::filesystem::path" 3cxx "Sun Jan 8 2023" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::experimental::filesystem::path \- A filesystem path\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <filesystem>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBiterator\fP"
.br
.RI "An iterator for the components of a path\&. "
.in -1c
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef \fBiterator\fP \fBconst_iterator\fP"
.br
.ti -1c
.RI "typedef \fBstd::basic_string\fP< value_type > \fBstring_type\fP"
.br
.ti -1c
.RI "typedef char \fBvalue_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "template<typename _InputIterator , typename _Require  = __detail::_Path<_InputIterator, _InputIterator>> \fBpath\fP (_InputIterator __first, _InputIterator __last)"
.br
.ti -1c
.RI "template<typename _InputIterator , typename _Require  = __detail::_Path<_InputIterator, _InputIterator>, typename _Require2  = __detail::__value_type_is_char<_InputIterator>> \fBpath\fP (_InputIterator __first, _InputIterator __last, const \fBlocale\fP &__loc)"
.br
.ti -1c
.RI "template<typename _Source , typename _Require  = __detail::_Path<_Source>> \fBpath\fP (_Source const &__source)"
.br
.ti -1c
.RI "template<typename _Source , typename _Require  = __detail::_Path<_Source>, typename _Require2  = __detail::__value_type_is_char<_Source>> \fBpath\fP (_Source const &__source, const \fBlocale\fP &__loc)"
.br
.ti -1c
.RI "\fBpath\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "\fBpath\fP (\fBpath\fP &&__p) noexcept"
.br
.ti -1c
.RI "\fBpath\fP (\fBstring_type\fP &&__source)"
.br
.ti -1c
.RI "template<typename _InputIterator > __detail::_Path< _InputIterator, _InputIterator > & \fBappend\fP (_InputIterator __first, _InputIterator __last)"
.br
.ti -1c
.RI "template<typename _Source > __detail::_Path< _Source > & \fBappend\fP (_Source const &__source)"
.br
.ti -1c
.RI "template<typename _InputIterator > __detail::_Path< _InputIterator, _InputIterator > & \fBassign\fP (_InputIterator __first, _InputIterator __last)"
.br
.ti -1c
.RI "template<typename _Source > __detail::_Path< _Source > & \fBassign\fP (_Source const &__source)"
.br
.ti -1c
.RI "\fBpath\fP & \fBassign\fP (\fBstring_type\fP &&__source)"
.br
.ti -1c
.RI "\fBiterator\fP \fBbegin\fP () const noexcept"
.br
.ti -1c
.RI "const value_type * \fBc_str\fP () const noexcept"
.br
.ti -1c
.RI "void \fBclear\fP () noexcept"
.br
.ti -1c
.RI "int \fBcompare\fP (const \fBbasic_string_view\fP< value_type > __s) const"
.br
.ti -1c
.RI "int \fBcompare\fP (const \fBpath\fP &__p) const noexcept"
.br
.ti -1c
.RI "int \fBcompare\fP (const \fBstring_type\fP &__s) const"
.br
.ti -1c
.RI "int \fBcompare\fP (const value_type *__s) const"
.br
.ti -1c
.RI "template<typename _InputIterator > __detail::_Path< _InputIterator, _InputIterator > & \fBconcat\fP (_InputIterator __first, _InputIterator __last)"
.br
.ti -1c
.RI "template<typename _Source > __detail::_Path< _Source > & \fBconcat\fP (_Source const &__x)"
.br
.ti -1c
.RI "bool \fBempty\fP () const noexcept"
.br
.ti -1c
.RI "\fBiterator\fP \fBend\fP () const noexcept"
.br
.ti -1c
.RI "\fBpath\fP \fBextension\fP () const"
.br
.ti -1c
.RI "\fBpath\fP \fBfilename\fP () const"
.br
.ti -1c
.RI "\fBstd::string\fP \fBgeneric_string\fP () const"
.br
.ti -1c
.RI "template<typename _CharT , typename _Traits  = std::char_traits<_CharT>, typename _Allocator  = std::allocator<_CharT>> \fBstd::basic_string\fP< _CharT, _Traits, _Allocator > \fBgeneric_string\fP (const _Allocator &__a=_Allocator()) const"
.br
.ti -1c
.RI "\fBstd::u16string\fP \fBgeneric_u16string\fP () const"
.br
.ti -1c
.RI "\fBstd::u32string\fP \fBgeneric_u32string\fP () const"
.br
.ti -1c
.RI "\fBstd::string\fP \fBgeneric_u8string\fP () const"
.br
.ti -1c
.RI "\fBstd::wstring\fP \fBgeneric_wstring\fP () const"
.br
.ti -1c
.RI "bool \fBhas_extension\fP () const"
.br
.ti -1c
.RI "bool \fBhas_filename\fP () const"
.br
.ti -1c
.RI "bool \fBhas_parent_path\fP () const"
.br
.ti -1c
.RI "bool \fBhas_relative_path\fP () const"
.br
.ti -1c
.RI "bool \fBhas_root_directory\fP () const"
.br
.ti -1c
.RI "bool \fBhas_root_name\fP () const"
.br
.ti -1c
.RI "bool \fBhas_root_path\fP () const"
.br
.ti -1c
.RI "bool \fBhas_stem\fP () const"
.br
.ti -1c
.RI "bool \fBis_absolute\fP () const"
.br
.ti -1c
.RI "bool \fBis_relative\fP () const"
.br
.ti -1c
.RI "\fBpath\fP & \fBmake_preferred\fP ()"
.br
.ti -1c
.RI "const \fBstring_type\fP & \fBnative\fP () const noexcept"
.br
.ti -1c
.RI "\fBoperator string_type\fP () const"
.br
.ti -1c
.RI "template<typename _CharT > __detail::_Path< _CharT *, _CharT * > & \fBoperator+=\fP (_CharT __x)"
.br
.ti -1c
.RI "template<typename _Source > __detail::_Path< _Source > & \fBoperator+=\fP (_Source const &__x)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator+=\fP (\fBbasic_string_view\fP< value_type > __x)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator+=\fP (const \fBpath\fP &__x)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator+=\fP (const \fBstring_type\fP &__x)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator+=\fP (const value_type *__x)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator+=\fP (value_type __x)"
.br
.ti -1c
.RI "template<typename _Source > __detail::_Path< _Source > & \fBoperator/=\fP (_Source const &__source)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator/=\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "template<typename _Source > __detail::_Path< _Source > & \fBoperator=\fP (_Source const &__source)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator=\fP (const \fBpath\fP &__p)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator=\fP (\fBpath\fP &&__p) noexcept"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator=\fP (\fBstring_type\fP &&__source)"
.br
.ti -1c
.RI "\fBpath\fP \fBparent_path\fP () const"
.br
.ti -1c
.RI "\fBpath\fP \fBrelative_path\fP () const"
.br
.ti -1c
.RI "\fBpath\fP & \fBremove_filename\fP ()"
.br
.ti -1c
.RI "\fBpath\fP & \fBreplace_extension\fP (const \fBpath\fP &__replacement=\fBpath\fP())"
.br
.ti -1c
.RI "\fBpath\fP & \fBreplace_filename\fP (const \fBpath\fP &__replacement)"
.br
.ti -1c
.RI "\fBpath\fP \fBroot_directory\fP () const"
.br
.ti -1c
.RI "\fBpath\fP \fBroot_name\fP () const"
.br
.ti -1c
.RI "\fBpath\fP \fBroot_path\fP () const"
.br
.ti -1c
.RI "\fBpath\fP \fBstem\fP () const"
.br
.ti -1c
.RI "\fBstd::string\fP \fBstring\fP () const"
.br
.ti -1c
.RI "template<typename _CharT , typename _Traits  = std::char_traits<_CharT>, typename _Allocator  = std::allocator<_CharT>> \fBstd::basic_string\fP< _CharT, _Traits, _Allocator > \fBstring\fP (const _Allocator &__a=_Allocator()) const"
.br
.ti -1c
.RI "void \fBswap\fP (\fBpath\fP &__rhs) noexcept"
.br
.ti -1c
.RI "\fBstd::u16string\fP \fBu16string\fP () const"
.br
.ti -1c
.RI "\fBstd::u32string\fP \fBu32string\fP () const"
.br
.ti -1c
.RI "\fBstd::string\fP \fBu8string\fP () const"
.br
.ti -1c
.RI "\fBstd::wstring\fP \fBwstring\fP () const"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr value_type \fBpreferred_separator\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A filesystem path\&. 
.PP
Definition at line \fB201\fP of file \fBexperimental/bits/filesystem\fP\&.
.SH "Member Typedef Documentation"
.PP 
.SS "typedef \fBiterator\fP \fBstd::experimental::filesystem::path::const_iterator\fP"

.PP
Definition at line \fB416\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "typedef \fBstd::basic_string\fP<value_type> \fBstd::experimental::filesystem::path::string_type\fP"

.PP
Definition at line \fB211\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "typedef char std::experimental::filesystem::path::value_type"

.PP
Definition at line \fB208\fP of file \fBexperimental/bits/filesystem\fP\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename _Source , typename _Require  = __detail::_Path<_Source>> std::experimental::filesystem::path::path (_Source const & __source)\fC [inline]\fP"

.PP
Definition at line \fB223\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _InputIterator , typename _Require  = __detail::_Path<_InputIterator, _InputIterator>> std::experimental::filesystem::path::path (_InputIterator __first, _InputIterator __last)\fC [inline]\fP"

.PP
Definition at line \fB230\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _Source , typename _Require  = __detail::_Path<_Source>, typename _Require2  = __detail::__value_type_is_char<_Source>> std::experimental::filesystem::path::path (_Source const & __source, const \fBlocale\fP & __loc)\fC [inline]\fP"

.PP
Definition at line \fB237\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _InputIterator , typename _Require  = __detail::_Path<_InputIterator, _InputIterator>, typename _Require2  = __detail::__value_type_is_char<_InputIterator>> std::experimental::filesystem::path::path (_InputIterator __first, _InputIterator __last, const \fBlocale\fP & __loc)\fC [inline]\fP"

.PP
Definition at line \fB245\fP of file \fBexperimental/bits/filesystem\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "template<typename _InputIterator > __detail::_Path< _InputIterator, _InputIterator > & std::experimental::filesystem::path::append (_InputIterator __first, _InputIterator __last)\fC [inline]\fP"

.PP
Definition at line \fB292\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _Source > __detail::_Path< _Source > & std::experimental::filesystem::path::append (_Source const & __source)\fC [inline]\fP"

.PP
Definition at line \fB284\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _InputIterator > __detail::_Path< _InputIterator, _InputIterator > & std::experimental::filesystem::path::assign (_InputIterator __first, _InputIterator __last)\fC [inline]\fP"

.PP
Definition at line \fB270\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _Source > __detail::_Path< _Source > & std::experimental::filesystem::path::assign (_Source const & __source)\fC [inline]\fP"

.PP
Definition at line \fB265\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "const value_type * std::experimental::filesystem::path::c_str () const\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB340\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "void std::experimental::filesystem::path::clear ()\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB328\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _InputIterator > __detail::_Path< _InputIterator, _InputIterator > & std::experimental::filesystem::path::concat (_InputIterator __first, _InputIterator __last)\fC [inline]\fP"

.PP
Definition at line \fB323\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _Source > __detail::_Path< _Source > & std::experimental::filesystem::path::concat (_Source const & __x)\fC [inline]\fP"

.PP
Definition at line \fB315\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "bool std::experimental::filesystem::path::empty () const\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB402\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "bool std::experimental::filesystem::path::is_relative () const\fC [inline]\fP"

.PP
Definition at line \fB412\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "const \fBstring_type\fP & std::experimental::filesystem::path::native () const\fC [inline]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB339\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "std::experimental::filesystem::path::operator \fBstring_type\fP () const\fC [inline]\fP"

.PP
Definition at line \fB341\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _Source > __detail::_Path< _Source > & std::experimental::filesystem::path::operator+= (_Source const & __x)\fC [inline]\fP"

.PP
Definition at line \fB307\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _Source > __detail::_Path< _Source > & std::experimental::filesystem::path::operator/= (_Source const & __source)\fC [inline]\fP"

.PP
Definition at line \fB279\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "\fBpath\fP & std::experimental::filesystem::path::operator/= (const \fBpath\fP & __p)\fC [inline]\fP"

.PP
Definition at line \fB275\fP of file \fBexperimental/bits/filesystem\fP\&.
.SS "template<typename _Source > __detail::_Path< _Source > & std::experimental::filesystem::path::operator= (_Source const & __source)\fC [inline]\fP"

.PP
Definition at line \fB260\fP of file \fBexperimental/bits/filesystem\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "constexpr value_type std::experimental::filesystem::path::preferred_separator\fC [static]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB209\fP of file \fBexperimental/bits/filesystem\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.