.TH "std::filesystem::path" 3cxx "Wed Jul 28 2021" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::filesystem::path \- A filesystem path\&.  

.SH SYNOPSIS
.br
.PP
.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 "using \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 "using \fBstring_type\fP = \fBstd::basic_string\fP< value_type >"
.br
.ti -1c
.RI "using \fBvalue_type\fP = char"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "template<typename _InputIterator , typename _Require  = __detail::_Path2<_InputIterator>, typename _Req2  = __detail::__value_type_is_char<_InputIterator>> \fBpath\fP (_InputIterator __first, _InputIterator __last, const \fBlocale\fP &__loc, \fBformat\fP=auto_format)"
.br
.ti -1c
.RI "template<typename _InputIterator , typename _Require  = __detail::_Path2<_InputIterator>> \fBpath\fP (_InputIterator __first, _InputIterator __last, \fBformat\fP=auto_format)"
.br
.ti -1c
.RI "template<typename _Source , typename _Require  = __detail::_Path<_Source>> \fBpath\fP (_Source const &__source, \fBformat\fP=auto_format)"
.br
.ti -1c
.RI "template<typename _Source , typename _Require  = __detail::_Path<_Source>, typename _Require2  = __detail::__value_type_is_char<_Source>> \fBpath\fP (_Source const &__src, const \fBlocale\fP &__loc, \fBformat\fP=auto_format)"
.br
.ti -1c
.RI "\fBpath\fP (const \fBpath\fP &__p)=default"
.br
.ti -1c
.RI "\fBpath\fP (\fBpath\fP &&__p) noexcept"
.br
.ti -1c
.RI "\fBpath\fP (\fBstring_type\fP &&__source, \fBformat\fP=auto_format)"
.br
.ti -1c
.RI "template<typename _InputIterator > __detail::_Path2< _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::_Path2< _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"
.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 (\fBbasic_string_view\fP< value_type > __s) const noexcept"
.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 noexcept"
.br
.ti -1c
.RI "int \fBcompare\fP (const value_type *__s) const noexcept"
.br
.ti -1c
.RI "template<typename _InputIterator > __detail::_Path2< _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"
.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 noexcept"
.br
.ti -1c
.RI "bool \fBhas_filename\fP () const noexcept"
.br
.ti -1c
.RI "bool \fBhas_parent_path\fP () const noexcept"
.br
.ti -1c
.RI "bool \fBhas_relative_path\fP () const noexcept"
.br
.ti -1c
.RI "bool \fBhas_root_directory\fP () const noexcept"
.br
.ti -1c
.RI "bool \fBhas_root_name\fP () const noexcept"
.br
.ti -1c
.RI "bool \fBhas_root_path\fP () const noexcept"
.br
.ti -1c
.RI "bool \fBhas_stem\fP () const noexcept"
.br
.ti -1c
.RI "bool \fBis_absolute\fP () const noexcept"
.br
.ti -1c
.RI "bool \fBis_relative\fP () const noexcept"
.br
.ti -1c
.RI "\fBpath\fP \fBlexically_normal\fP () const"
.br
.ti -1c
.RI "\fBpath\fP \fBlexically_proximate\fP (const \fBpath\fP &base) const"
.br
.ti -1c
.RI "\fBpath\fP \fBlexically_relative\fP (const \fBpath\fP &base) 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::_Path2< _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 &)"
.br
.ti -1c
.RI "\fBpath\fP & \fBoperator=\fP (\fBpath\fP &&) 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 , typename _Allocator > \fBbasic_string\fP< _CharT, _Traits, _Allocator > \fBstring\fP (const _Allocator &__a) 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
.SS "Friends"

.in +1c
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBpath\fP &__lhs, const \fBpath\fP &__rhs) noexcept"
.br
.RI "Compare paths\&. "
.ti -1c
.RI "\fBpath\fP \fBoperator/\fP (const \fBpath\fP &__lhs, const \fBpath\fP &__rhs)"
.br
.RI "Append one path to another\&. "
.ti -1c
.RI "bool \fBoperator<\fP (const \fBpath\fP &__lhs, const \fBpath\fP &__rhs) noexcept"
.br
.RI "Compare paths\&. "
.ti -1c
.RI "template<typename _CharT , typename _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &__os, const \fBpath\fP &__p)"
.br
.RI "Write a path to a stream\&. "
.ti -1c
.RI "bool \fBoperator<=\fP (const \fBpath\fP &__lhs, const \fBpath\fP &__rhs) noexcept"
.br
.RI "Compare paths\&. "
.ti -1c
.RI "bool \fBoperator==\fP (const \fBpath\fP &__lhs, const \fBpath\fP &__rhs) noexcept"
.br
.RI "Compare paths\&. "
.ti -1c
.RI "bool \fBoperator>\fP (const \fBpath\fP &__lhs, const \fBpath\fP &__rhs) noexcept"
.br
.RI "Compare paths\&. "
.ti -1c
.RI "bool \fBoperator>=\fP (const \fBpath\fP &__lhs, const \fBpath\fP &__rhs) noexcept"
.br
.RI "Compare paths\&. "
.ti -1c
.RI "template<typename _CharT , typename _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &__is, \fBpath\fP &__p)"
.br
.RI "Read a path from a stream\&. "
.in -1c
.SS "Related Functions"
(Note that these are not member functions\&.) 
.in +1c
.ti -1c
.RI "template<typename _InputIterator , typename _Require  = __detail::_Path2<_InputIterator>, typename _CharT  = __detail::__value_type_is_char_or_char8_t<_InputIterator>> \fBpath\fP \fBu8path\fP (_InputIterator __first, _InputIterator __last)"
.br
.ti -1c
.RI "template<typename _Source , typename _Require  = __detail::_Path<_Source>, typename _CharT  = __detail::__value_type_is_char_or_char8_t<_Source>> \fBpath\fP \fBu8path\fP (const _Source &__source)"
.br
.in -1c
.PP
.RI "\fB\fP"
.br

.in +1c
.in +1c
.ti -1c
.RI "void \fBswap\fP (\fBpath\fP &__lhs, \fBpath\fP &__rhs) noexcept"
.br
.ti -1c
.RI "size_t \fBhash_value\fP (const \fBpath\fP &__p) noexcept"
.br
.in -1c
.in -1c
.SH "Detailed Description"
.PP 
A filesystem path\&. 
.PP
Definition at line 245 of file bits/fs_path\&.h\&.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBstd::filesystem::path::format\fP : unsigned char"

.PP
path::format is ignored in this implementation 
.PP
Definition at line 263 of file bits/fs_path\&.h\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "bool operator!= (const \fBpath\fP & __lhs, const \fBpath\fP & __rhs)\fC [friend]\fP"

.PP
Compare paths\&. 
.PP
Definition at line 525 of file bits/fs_path\&.h\&.
.SS "\fBpath\fP operator/ (const \fBpath\fP & __lhs, const \fBpath\fP & __rhs)\fC [friend]\fP"

.PP
Append one path to another\&. 
.PP
Definition at line 546 of file bits/fs_path\&.h\&.
.SS "bool operator< (const \fBpath\fP & __lhs, const \fBpath\fP & __rhs)\fC [friend]\fP"

.PP
Compare paths\&. 
.PP
Definition at line 529 of file bits/fs_path\&.h\&.
.SS "template<typename _CharT , typename _Traits > \fBstd::basic_ostream\fP<_CharT, _Traits>& operator<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, const \fBpath\fP & __p)\fC [friend]\fP"

.PP
Write a path to a stream\&. 
.PP
Definition at line 494 of file bits/fs_path\&.h\&.
.SS "bool operator<= (const \fBpath\fP & __lhs, const \fBpath\fP & __rhs)\fC [friend]\fP"

.PP
Compare paths\&. 
.PP
Definition at line 533 of file bits/fs_path\&.h\&.
.SS "bool operator== (const \fBpath\fP & __lhs, const \fBpath\fP & __rhs)\fC [friend]\fP"

.PP
Compare paths\&. 
.PP
Definition at line 515 of file bits/fs_path\&.h\&.
.SS "bool operator> (const \fBpath\fP & __lhs, const \fBpath\fP & __rhs)\fC [friend]\fP"

.PP
Compare paths\&. 
.PP
Definition at line 537 of file bits/fs_path\&.h\&.
.SS "bool operator>= (const \fBpath\fP & __lhs, const \fBpath\fP & __rhs)\fC [friend]\fP"

.PP
Compare paths\&. 
.PP
Definition at line 541 of file bits/fs_path\&.h\&.
.SS "template<typename _CharT , typename _Traits > \fBstd::basic_istream\fP<_CharT, _Traits>& operator>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBpath\fP & __p)\fC [friend]\fP"

.PP
Read a path from a stream\&. 
.PP
Definition at line 504 of file bits/fs_path\&.h\&.

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