logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

std::filesystem::path - A filesystem path.

Author

       Generated automatically by Doxygen for libstdc++ from the source code.

                                                    libstdc++                        std::filesystem::path(3cxx)

Detailed Description

       A filesystem path.

Member Enumeration Documentation

enumstd::filesystem::path::format:unsignedchar
       path::format is ignored in this implementation

Name

       std::filesystem::path - A filesystem path.

Synopsis

       #include <fs_path.h>

   Classes
       class iterator
           An iterator for the components of a path.

   PublicTypesusingconst_iterator = iterator
       enum format : unsigned char { native_format, generic_format, auto_format }
           path::format is ignored in this implementation
       usingstring_type = std::basic_string< value_type >
       usingvalue_type = char

   PublicMemberFunctions
       template<typename_InputIterator , typename_Require  = __detail::_Path2<_InputIterator>, typename_Req2
           = __detail::__value_type_is_char<_InputIterator>> path (_InputIterator __first, _InputIterator
           __last, constlocale &__loc, format=auto_format)
       template<typename_InputIterator , typename_Require  = __detail::_Path2<_InputIterator>> path
           (_InputIterator __first, _InputIterator __last, format=auto_format)
       template<typename_Source , typename_Require  = __detail::_Path<_Source>> path (_Sourceconst &__source,
           format=auto_format)
       template<typename_Source , typename_Require  = __detail::_Path<_Source>, typename_Require2  =
           __detail::__value_type_is_char<_Source>> path (_Sourceconst &__src, constlocale &__loc,
           format=auto_format)
       path (constpath &__p)=defaultpath (path &&__p) noexceptpath (string_type &&__source, format=auto_format)
       template<typename_InputIterator > __detail::_Path2< _InputIterator > & append (_InputIterator __first,
           _InputIterator __last)
       template<typename_Source > __detail::_Path< _Source > & append (_Sourceconst &__source)
       template<typename_InputIterator > __detail::_Path2< _InputIterator > & assign (_InputIterator __first,
           _InputIterator __last)
       template<typename_Source > __detail::_Path< _Source > & assign (_Sourceconst &__source)
       path & assign (string_type &&__source)
       iteratorbegin () constconst value_type * c_str () constnoexceptvoidclear () noexcept
       int compare (basic_string_view< value_type > __s) constnoexcept
       int compare (constpath &__p) constnoexcept
       int compare (conststring_type &__s) constnoexcept
       int compare (const value_type *__s) constnoexcept
       template<typename_InputIterator > __detail::_Path2< _InputIterator > & concat (_InputIterator __first,
           _InputIterator __last)
       template<typename_Source > __detail::_Path< _Source > & concat (_Sourceconst &__x)
       bool empty () constnoexceptiteratorend () constpathextension () constpathfilename () conststd::stringgeneric_string () const
       template<typename _CharT , typename _Traits  = std::char_traits<_CharT>, typename_Allocator  =
           std::allocator<_CharT>> std::basic_string< _CharT, _Traits, _Allocator > generic_string (const_Allocator &__a=_Allocator()) conststd::u16stringgeneric_u16string () conststd::u32stringgeneric_u32string () conststd::stringgeneric_u8string () conststd::wstringgeneric_wstring () const
       bool has_extension () constnoexcept
       bool has_filename () constnoexcept
       bool has_parent_path () constnoexcept
       bool has_relative_path () constnoexcept
       bool has_root_directory () constnoexcept
       bool has_root_name () constnoexcept
       bool has_root_path () constnoexcept
       bool has_stem () constnoexcept
       bool is_absolute () constnoexcept
       bool is_relative () constnoexceptpathlexically_normal () constpathlexically_proximate (constpath &base) constpathlexically_relative (constpath &base) constpath & make_preferred ()
       conststring_type & native () constnoexceptoperatorstring_type () const
       template<typename _CharT > __detail::_Path2< _CharT * > & operator+= (_CharT __x)
       template<typename_Source > __detail::_Path< _Source > & operator+= (_Sourceconst &__x)
       path & operator+= (basic_string_view< value_type > __x)
       path & operator+= (constpath &__x)
       path & operator+= (conststring_type &__x)
       path & operator+= (const value_type *__x)
       path & operator+= (value_type __x)
       template<typename_Source > __detail::_Path< _Source > & operator/= (_Sourceconst &__source)
       path & operator/= (constpath &__p)
       template<typename_Source > __detail::_Path< _Source > & operator= (_Sourceconst &__source)
       path & operator= (constpath &)
       path & operator= (path &&) noexceptpath & operator= (string_type &&__source)
       pathparent_path () constpathrelative_path () constpath & remove_filename ()
       path & replace_extension (constpath &__replacement=path())
       path & replace_filename (constpath &__replacement)
       pathroot_directory () constpathroot_name () constpathroot_path () constpathstem () conststd::stringstring () const
       template<typename _CharT , typename _Traits , typename_Allocator > basic_string< _CharT, _Traits,
           _Allocator > string (const_Allocator &__a) const
       template<typename _CharT , typename _Traits  = std::char_traits<_CharT>, typename_Allocator  =
           std::allocator<_CharT>> std::basic_string< _CharT, _Traits, _Allocator > string (const_Allocator
           &__a=_Allocator()) constvoidswap (path &__rhs) noexceptstd::u16stringu16string () conststd::u32stringu32string () conststd::stringu8string () conststd::wstringwstring () constStaticPublicAttributesstaticconstexpr value_type preferred_separatorFriends
       bool operator!= (constpath &__lhs, constpath &__rhs) noexcept
           Compare paths.
       pathoperator/ (constpath &__lhs, constpath &__rhs)
           Append one path to another.
       bool operator< (constpath &__lhs, constpath &__rhs) noexcept
           Compare paths.
       template<typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits > & operator<<
           (std::basic_ostream< _CharT, _Traits > &__os, constpath &__p)
           Write a path to a stream.
       bool operator<= (constpath &__lhs, constpath &__rhs) noexcept
           Compare paths.
       bool operator== (constpath &__lhs, constpath &__rhs) noexcept
           Compare paths.
       bool operator> (constpath &__lhs, constpath &__rhs) noexcept
           Compare paths.
       bool operator>= (constpath &__lhs, constpath &__rhs) noexcept
           Compare paths.
       template<typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits > & operator>>
           (std::basic_istream< _CharT, _Traits > &__is, path &__p)
           Read a path from a stream.

   RelatedSymbols
       (Note that these are not member symbols.)
       voidswap (path &__lhs, path &__rhs) noexcept
       template<typename_InputIterator , typename_Require  = __detail::_Path2<_InputIterator>, typename _CharT
           = __detail::__value_type_is_char_or_char8_t<_InputIterator>> pathu8path (_InputIterator __first,
           _InputIterator __last)
       template<typename_Source , typename_Require  = __detail::_Path<_Source>, typename _CharT  =
           __detail::__value_type_is_char_or_char8_t<_Source>> pathu8path (const_Source &__source)

See Also