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.

       Since
           C++17

Member Enumeration Documentation

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

Name

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

Synopsis

       #include <filesystem>

   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, const locale &__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 (_Source const &__source,
           format=auto_format)
       template<typename_Source , typename_Require  = __detail::_Path<_Source>, typename_Require2  =
           __detail::__value_type_is_char<_Source>> path (_Source const &__src, const locale &__loc,
           format=auto_format)
       path (const path &__p)=defaultpath (path &&__p) noexcept
       path (string_type &&__source, format=auto_format)
       template<typename_InputIterator > __detail::_Path2< _InputIterator > & append (_InputIterator __first,
           _InputIterator __last)
       template<typename_Source > __detail::_Path< _Source > & append (_Source const &__source)
       template<typename_InputIterator > __detail::_Path2< _InputIterator > & assign (_InputIterator __first,
           _InputIterator __last)
       template<typename_Source > __detail::_Path< _Source > & assign (_Source const &__source)
       path & assign (string_type &&__source)
       iteratorbegin () const noexcept
       const value_type * c_str () const noexcept
       voidclear () noexcept
       int compare (basic_string_view< value_type > __s) const noexcept
       int compare (const path &__p) const noexcept
       int compare (const string_type &__s) const noexcept
       int compare (const value_type *__s) const noexcept
       template<typename_InputIterator > __detail::_Path2< _InputIterator > & concat (_InputIterator __first,
           _InputIterator __last)
       template<typename_Source > __detail::_Path< _Source > & concat (_Source const &__x)
       bool empty () const noexcept
       iteratorend () const noexcept
       pathextension () const
       pathfilename () const
       std::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()) const
       std::u16stringgeneric_u16string () const
       std::u32stringgeneric_u32string () const
       std::stringgeneric_u8string () const
       std::wstringgeneric_wstring () const
       bool has_extension () const noexcept
       bool has_filename () const noexcept
       bool has_parent_path () const noexcept
       bool has_relative_path () const noexcept
       bool has_root_directory () const noexcept
       bool has_root_name () const noexcept
       bool has_root_path () const noexcept
       bool has_stem () const noexcept
       bool is_absolute () const noexcept
       bool is_relative () const noexcept
       pathlexically_normal () const
       pathlexically_proximate (const path &base) const
       pathlexically_relative (const path &base) const
       path & make_preferred ()
       const string_type & native () const noexcept
       operatorstring_type () const
       template<typename _CharT > __detail::_Path2< _CharT * > & operator+= (_CharT __x)
       template<typename_Source > __detail::_Path< _Source > & operator+= (_Source const &__x)
       path & operator+= (basic_string_view< value_type > __x)
       path & operator+= (const path &__x)
       path & operator+= (const string_type &__x)
       path & operator+= (const value_type *__x)
       path & operator+= (value_type __x)
       template<typename_Source > __detail::_Path< _Source > & operator/= (_Source const &__source)
       path & operator/= (const path &__p)
       template<typename_Source > __detail::_Path< _Source > & operator= (_Source const &__source)
       path & operator= (const path &)
       path & operator= (path &&) noexcept
       path & operator= (string_type &&__source)
       pathparent_path () const
       pathrelative_path () const
       path & remove_filename ()
       path & replace_extension (const path &__replacement=path())
       path & replace_filename (const path &__replacement)
       pathroot_directory () const
       pathroot_name () const
       pathroot_path () const
       pathstem () const
       std::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()) const
       voidswap (path &__rhs) noexcept
       std::u16stringu16string () const
       std::u32stringu32string () const
       std::stringu8string () const
       std::wstringwstring () const

   StaticPublicAttributesstatic constexpr value_type preferred_separatorFriends
       bool operator!= (const path &__lhs, const path &__rhs) noexcept
           Compare paths.
       pathoperator/ (const path &__lhs, const path &__rhs)
           Append one path to another.
       bool operator< (const path &__lhs, const path &__rhs) noexcept
           Compare paths.
       template<typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits > & operator<<
           (std::basic_ostream< _CharT, _Traits > &__os, const path &__p)
           Write a path to a stream.
       bool operator<= (const path &__lhs, const path &__rhs) noexcept
           Compare paths.
       bool operator== (const path &__lhs, const path &__rhs) noexcept
           Compare paths.
       bool operator> (const path &__lhs, const path &__rhs) noexcept
           Compare paths.
       bool operator>= (const path &__lhs, const path &__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