.TH "std::filesystem::path" 3cxx "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::filesystem::path \- A filesystem path\&. .SH SYNOPSIS .br .PP .PP \fC#include \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 "\fBusing\fP \fBconst_iterator\fP = \fBiterator\fP" .br .ti -1c .RI "enum \fBformat\fP : unsigned char { \fBnative_format\fP, \fBgeneric_format\fP, \fBauto_format\fP }" .br .RI "path::format is ignored in this implementation " .ti -1c .RI "\fBusing\fP \fBstring_type\fP = \fBstd::basic_string\fP< value_type >" .br .ti -1c .RI "\fBusing\fP \fBvalue_type\fP = char" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "template<\fBtypename\fP \fB_InputIterator\fP , \fBtypename\fP \fB_Require\fP = __detail::_Path2<_InputIterator>, \fBtypename\fP \fB_Req2\fP = __detail::__value_type_is_char<_InputIterator>> \fBpath\fP (\fB_InputIterator\fP __first, \fB_InputIterator\fP __last, \fBconst\fP \fBlocale\fP &\fB__loc\fP, \fBformat\fP=auto_format)" .br .ti -1c .RI "template<\fBtypename\fP \fB_InputIterator\fP , \fBtypename\fP \fB_Require\fP = __detail::_Path2<_InputIterator>> \fBpath\fP (\fB_InputIterator\fP __first, \fB_InputIterator\fP __last, \fBformat\fP=auto_format)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP , \fBtypename\fP \fB_Require\fP = __detail::_Path<_Source>> \fBpath\fP (\fB_Source\fP \fBconst\fP &\fB__source\fP, \fBformat\fP=auto_format)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP , \fBtypename\fP \fB_Require\fP = __detail::_Path<_Source>, \fBtypename\fP \fB_Require2\fP = __detail::__value_type_is_char<_Source>> \fBpath\fP (\fB_Source\fP \fBconst\fP &\fB__src\fP, \fBconst\fP \fBlocale\fP &\fB__loc\fP, \fBformat\fP=auto_format)" .br .ti -1c .RI "\fBpath\fP (\fBconst\fP \fBpath\fP &__p)=\fBdefault\fP" .br .ti -1c .RI "\fBpath\fP (\fBpath\fP &&__p) \fBnoexcept\fP" .br .ti -1c .RI "\fBpath\fP (\fBstring_type\fP &&\fB__source\fP, \fBformat\fP=auto_format)" .br .ti -1c .RI "template<\fBtypename\fP \fB_InputIterator\fP > __detail::_Path2< \fB_InputIterator\fP > & \fBappend\fP (\fB_InputIterator\fP __first, \fB_InputIterator\fP __last)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP > __detail::_Path< \fB_Source\fP > & \fBappend\fP (\fB_Source\fP \fBconst\fP &\fB__source\fP)" .br .ti -1c .RI "template<\fBtypename\fP \fB_InputIterator\fP > __detail::_Path2< \fB_InputIterator\fP > & \fBassign\fP (\fB_InputIterator\fP __first, \fB_InputIterator\fP __last)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP > __detail::_Path< \fB_Source\fP > & \fBassign\fP (\fB_Source\fP \fBconst\fP &\fB__source\fP)" .br .ti -1c .RI "\fBpath\fP & \fBassign\fP (\fBstring_type\fP &&\fB__source\fP)" .br .ti -1c .RI "\fBiterator\fP \fBbegin\fP () \fBconst\fP" .br .ti -1c .RI "\fBconst\fP value_type * \fBc_str\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "\fBvoid\fP \fBclear\fP () \fBnoexcept\fP" .br .ti -1c .RI "int \fBcompare\fP (\fBbasic_string_view\fP< value_type > \fB__s\fP) \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "int \fBcompare\fP (\fBconst\fP \fBpath\fP &__p) \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "int \fBcompare\fP (\fBconst\fP \fBstring_type\fP &\fB__s\fP) \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "int \fBcompare\fP (\fBconst\fP value_type *\fB__s\fP) \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "template<\fBtypename\fP \fB_InputIterator\fP > __detail::_Path2< \fB_InputIterator\fP > & \fBconcat\fP (\fB_InputIterator\fP __first, \fB_InputIterator\fP __last)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP > __detail::_Path< \fB_Source\fP > & \fBconcat\fP (\fB_Source\fP \fBconst\fP &__x)" .br .ti -1c .RI "bool \fBempty\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "\fBiterator\fP \fBend\fP () \fBconst\fP" .br .ti -1c .RI "\fBpath\fP \fBextension\fP () \fBconst\fP" .br .ti -1c .RI "\fBpath\fP \fBfilename\fP () \fBconst\fP" .br .ti -1c .RI "\fBstd::string\fP \fBgeneric_string\fP () \fBconst\fP" .br .ti -1c .RI "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits = std::char_traits<_CharT>, \fBtypename\fP \fB_Allocator\fP = std::allocator<_CharT>> \fBstd::basic_string\fP< _CharT, _Traits, \fB_Allocator\fP > \fBgeneric_string\fP (\fBconst\fP \fB_Allocator\fP &__a=\fB_Allocator\fP()) \fBconst\fP" .br .ti -1c .RI "\fBstd::u16string\fP \fBgeneric_u16string\fP () \fBconst\fP" .br .ti -1c .RI "\fBstd::u32string\fP \fBgeneric_u32string\fP () \fBconst\fP" .br .ti -1c .RI "\fBstd::string\fP \fBgeneric_u8string\fP () \fBconst\fP" .br .ti -1c .RI "\fBstd::wstring\fP \fBgeneric_wstring\fP () \fBconst\fP" .br .ti -1c .RI "bool \fBhas_extension\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBhas_filename\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBhas_parent_path\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBhas_relative_path\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBhas_root_directory\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBhas_root_name\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBhas_root_path\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBhas_stem\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBis_absolute\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "bool \fBis_relative\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "\fBpath\fP \fBlexically_normal\fP () \fBconst\fP" .br .ti -1c .RI "\fBpath\fP \fBlexically_proximate\fP (\fBconst\fP \fBpath\fP &base) \fBconst\fP" .br .ti -1c .RI "\fBpath\fP \fBlexically_relative\fP (\fBconst\fP \fBpath\fP &base) \fBconst\fP" .br .ti -1c .RI "\fBpath\fP & \fBmake_preferred\fP ()" .br .ti -1c .RI "\fBconst\fP \fBstring_type\fP & \fBnative\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "\fBoperator string_type\fP () \fBconst\fP" .br .ti -1c .RI "template<\fBtypename\fP _CharT > __detail::_Path2< _CharT * > & \fBoperator+=\fP (_CharT __x)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP > __detail::_Path< \fB_Source\fP > & \fBoperator+=\fP (\fB_Source\fP \fBconst\fP &__x)" .br .ti -1c .RI "\fBpath\fP & \fBoperator+=\fP (\fBbasic_string_view\fP< value_type > __x)" .br .ti -1c .RI "\fBpath\fP & \fBoperator+=\fP (\fBconst\fP \fBpath\fP &__x)" .br .ti -1c .RI "\fBpath\fP & \fBoperator+=\fP (\fBconst\fP \fBstring_type\fP &__x)" .br .ti -1c .RI "\fBpath\fP & \fBoperator+=\fP (\fBconst\fP value_type *__x)" .br .ti -1c .RI "\fBpath\fP & \fBoperator+=\fP (value_type __x)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP > __detail::_Path< \fB_Source\fP > & \fBoperator/=\fP (\fB_Source\fP \fBconst\fP &\fB__source\fP)" .br .ti -1c .RI "\fBpath\fP & \fBoperator/=\fP (\fBconst\fP \fBpath\fP &__p)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP > __detail::_Path< \fB_Source\fP > & \fBoperator=\fP (\fB_Source\fP \fBconst\fP &\fB__source\fP)" .br .ti -1c .RI "\fBpath\fP & \fBoperator=\fP (\fBconst\fP \fBpath\fP &)" .br .ti -1c .RI "\fBpath\fP & \fBoperator=\fP (\fBpath\fP &&) \fBnoexcept\fP" .br .ti -1c .RI "\fBpath\fP & \fBoperator=\fP (\fBstring_type\fP &&\fB__source\fP)" .br .ti -1c .RI "\fBpath\fP \fBparent_path\fP () \fBconst\fP" .br .ti -1c .RI "\fBpath\fP \fBrelative_path\fP () \fBconst\fP" .br .ti -1c .RI "\fBpath\fP & \fBremove_filename\fP ()" .br .ti -1c .RI "\fBpath\fP & \fBreplace_extension\fP (\fBconst\fP \fBpath\fP &\fB__replacement\fP=\fBpath\fP())" .br .ti -1c .RI "\fBpath\fP & \fBreplace_filename\fP (\fBconst\fP \fBpath\fP &\fB__replacement\fP)" .br .ti -1c .RI "\fBpath\fP \fBroot_directory\fP () \fBconst\fP" .br .ti -1c .RI "\fBpath\fP \fBroot_name\fP () \fBconst\fP" .br .ti -1c .RI "\fBpath\fP \fBroot_path\fP () \fBconst\fP" .br .ti -1c .RI "\fBpath\fP \fBstem\fP () \fBconst\fP" .br .ti -1c .RI "\fBstd::string\fP \fBstring\fP () \fBconst\fP" .br .ti -1c .RI "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits , \fBtypename\fP \fB_Allocator\fP > \fBbasic_string\fP< _CharT, _Traits, \fB_Allocator\fP > \fBstring\fP (\fBconst\fP \fB_Allocator\fP &__a) \fBconst\fP" .br .ti -1c .RI "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits = std::char_traits<_CharT>, \fBtypename\fP \fB_Allocator\fP = std::allocator<_CharT>> \fBstd::basic_string\fP< _CharT, _Traits, \fB_Allocator\fP > \fBstring\fP (\fBconst\fP \fB_Allocator\fP &__a=\fB_Allocator\fP()) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBswap\fP (\fBpath\fP &\fB__rhs\fP) \fBnoexcept\fP" .br .ti -1c .RI "\fBstd::u16string\fP \fBu16string\fP () \fBconst\fP" .br .ti -1c .RI "\fBstd::u32string\fP \fBu32string\fP () \fBconst\fP" .br .ti -1c .RI "\fBstd::string\fP \fBu8string\fP () \fBconst\fP" .br .ti -1c .RI "\fBstd::wstring\fP \fBwstring\fP () \fBconst\fP" .br .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "\fBstatic\fP \fBconstexpr\fP value_type \fBpreferred_separator\fP" .br .in -1c .SS "Friends" .in +1c .ti -1c .RI "bool \fBoperator!=\fP (\fBconst\fP \fBpath\fP &\fB__lhs\fP, \fBconst\fP \fBpath\fP &\fB__rhs\fP) \fBnoexcept\fP" .br .RI "Compare paths\&. " .ti -1c .RI "\fBpath\fP \fBoperator/\fP (\fBconst\fP \fBpath\fP &\fB__lhs\fP, \fBconst\fP \fBpath\fP &\fB__rhs\fP)" .br .RI "Append one path to another\&. " .ti -1c .RI "bool \fBoperator<\fP (\fBconst\fP \fBpath\fP &\fB__lhs\fP, \fBconst\fP \fBpath\fP &\fB__rhs\fP) \fBnoexcept\fP" .br .RI "Compare paths\&. " .ti -1c .RI "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &\fB__os\fP, \fBconst\fP \fBpath\fP &__p)" .br .RI "Write a path to a stream\&. " .ti -1c .RI "bool \fBoperator<=\fP (\fBconst\fP \fBpath\fP &\fB__lhs\fP, \fBconst\fP \fBpath\fP &\fB__rhs\fP) \fBnoexcept\fP" .br .RI "Compare paths\&. " .ti -1c .RI "bool \fBoperator==\fP (\fBconst\fP \fBpath\fP &\fB__lhs\fP, \fBconst\fP \fBpath\fP &\fB__rhs\fP) \fBnoexcept\fP" .br .RI "Compare paths\&. " .ti -1c .RI "bool \fBoperator>\fP (\fBconst\fP \fBpath\fP &\fB__lhs\fP, \fBconst\fP \fBpath\fP &\fB__rhs\fP) \fBnoexcept\fP" .br .RI "Compare paths\&. " .ti -1c .RI "bool \fBoperator>=\fP (\fBconst\fP \fBpath\fP &\fB__lhs\fP, \fBconst\fP \fBpath\fP &\fB__rhs\fP) \fBnoexcept\fP" .br .RI "Compare paths\&. " .ti -1c .RI "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &\fB__is\fP, \fBpath\fP &__p)" .br .RI "Read a path from a stream\&. " .in -1c .SS "Related Symbols" (Note that these are not member symbols\&.) .in +1c .ti -1c .RI "\fBvoid\fP \fBswap\fP (\fBpath\fP &\fB__lhs\fP, \fBpath\fP &\fB__rhs\fP) \fBnoexcept\fP" .br .ti -1c .RI "template<\fBtypename\fP \fB_InputIterator\fP , \fBtypename\fP \fB_Require\fP = __detail::_Path2<_InputIterator>, \fBtypename\fP _CharT = __detail::__value_type_is_char_or_char8_t<_InputIterator>> \fBpath\fP \fBu8path\fP (\fB_InputIterator\fP __first, \fB_InputIterator\fP __last)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Source\fP , \fBtypename\fP \fB_Require\fP = __detail::_Path<_Source>, \fBtypename\fP _CharT = __detail::__value_type_is_char_or_char8_t<_Source>> \fBpath\fP \fBu8path\fP (\fBconst\fP \fB_Source\fP &\fB__source\fP)" .br .in -1c .SH "Detailed Description" .PP A filesystem path\&. .SH "Member Enumeration Documentation" .PP .SS "\fBenum\fP \fBstd::filesystem::path::format\fP : unsigned char" .PP path::format is ignored in this implementation .SH "Friends And Related Symbol Documentation" .PP .SS "bool operator!= (\fBconst\fP \fBpath\fP & __lhs, \fBconst\fP \fBpath\fP & __rhs)\fC [friend]\fP" .PP Compare paths\&. .SS "\fBpath\fP \fBoperator\fP/ (\fBconst\fP \fBpath\fP & __lhs, \fBconst\fP \fBpath\fP & __rhs)\fC [friend]\fP" .PP Append one path to another\&. .SS "bool \fBoperator\fP< (\fBconst\fP \fBpath\fP & __lhs, \fBconst\fP \fBpath\fP & __rhs)\fC [friend]\fP" .PP Compare paths\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator\fP<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, \fBconst\fP \fBpath\fP & __p)\fC [friend]\fP" .PP Write a path to a stream\&. .SS "bool \fBoperator\fP<= (\fBconst\fP \fBpath\fP & __lhs, \fBconst\fP \fBpath\fP & __rhs)\fC [friend]\fP" .PP Compare paths\&. .SS "bool \fBoperator\fP== (\fBconst\fP \fBpath\fP & __lhs, \fBconst\fP \fBpath\fP & __rhs)\fC [friend]\fP" .PP Compare paths\&. .SS "bool \fBoperator\fP> (\fBconst\fP \fBpath\fP & __lhs, \fBconst\fP \fBpath\fP & __rhs)\fC [friend]\fP" .PP Compare paths\&. .SS "bool \fBoperator\fP>= (\fBconst\fP \fBpath\fP & __lhs, \fBconst\fP \fBpath\fP & __rhs)\fC [friend]\fP" .PP Compare paths\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator\fP>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBpath\fP & __p)\fC [friend]\fP" .PP Read a path from a stream\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.