libstdc++: std::experimental::filesystem::v1::path Class Reference

libstdc++

std::experimental::filesystem::v1::path Class Reference
Technical Specifications » Filesystem TS

`#include <fs_path.h>`

## Classes
class | iterator

## Public Types
typedef iterator | const_iterator
typedef std::basic_string< value_type > | string_type
typedef char | value_type

## Public Member Functions
template<typename _InputIterator, typename _Require = __detail::_Path<_InputIterator, _InputIterator>>
| path (_InputIterator __first, _InputIterator __last)
template<typename _InputIterator, typename _Require = __detail::_Path<_InputIterator, _InputIterator>, typename _Require2 = __detail::__value_type_is_char<_InputIterator>>
| path (_InputIterator __first, _InputIterator __last, const locale &__loc)
template<typename _Source, typename _Require = __detail::_Path<_Source>>
| path (_Source const &__source)
template<typename _Source, typename _Require = __detail::_Path<_Source>, typename _Require2 = __detail::__value_type_is_char<_Source>>
| path (_Source const &__source, const locale &__loc)
| path (const path &__p)
| path (path &&__p) noexcept
| path (string_type &&__source)
template<typename _InputIterator>
__detail::_Path< _InputIterator, _InputIterator > & | append (_InputIterator __first, _InputIterator __last)
template<typename _Source>
__detail::_Path< _Source > & | append (_Source const &__source)
template<typename _InputIterator>
__detail::_Path< _InputIterator, _InputIterator > & | assign (_InputIterator __first, _InputIterator __last)
template<typename _Source>
__detail::_Path< _Source > & | assign (_Source const &__source)
path & | assign (string_type &&__source)
iterator | begin () const noexcept
const value_type * | c_str () const noexcept
void | clear () noexcept
int | compare (const basic_string_view< value_type > __s) const
int | compare (const path &__p) const noexcept
int | compare (const string_type &__s) const
int | compare (const value_type *__s) const
template<typename _InputIterator>
__detail::_Path< _InputIterator, _InputIterator > & | concat (_InputIterator __first, _InputIterator __last)
template<typename _Source>
__detail::_Path< _Source > & | concat (_Source const &__x)
bool | empty () const noexcept
iterator | end () const noexcept
path | extension () const
path | filename () const
std::string | generic_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::u16string | generic_u16string () const
std::u32string | generic_u32string () const
std::string | generic_u8string () const
std::wstring | generic_wstring () const
bool | has_extension () const
bool | has_filename () const
bool | has_parent_path () const
bool | has_relative_path () const
bool | has_root_directory () const
bool | has_root_name () const
bool | has_root_path () const
bool | has_stem () const
bool | is_absolute () const
bool | is_relative () const
path & | make_preferred ()
const string_type & | native () const noexcept
| operator string_type () const
template<typename _CharT>
__detail::_Path< _CharT *, _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 &__p)
path & | operator= (path &&__p) noexcept
path & | operator= (string_type &&__source)
path | parent_path () const
path | relative_path () const
path & | remove_filename ()
path & | replace_extension (const path &__replacement=path())
path & | replace_filename (const path &__replacement)
path | root_directory () const
path | root_name () const
path | root_path () const
path | stem () const
std::string | string () 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
void | swap (path &__rhs) noexcept
std::u16string | u16string () const
std::u32string | u32string () const
std::string | u8string () const
std::wstring | wstring () const

## Static Public Attributes
static constexpr value_type | preferred_separator

## Detailed Description

A filesystem path.

Definition at line 201 of file experimental/bits/fs_path.h.

## Member Typedef Documentation

## ◆ const_iterator

typedef iterator std::experimental::filesystem::v1::path::const_iterator

Definition at line 416 of file experimental/bits/fs_path.h.

## ◆ string_type

typedef std::basic_string<value_type> std::experimental::filesystem::v1::path::string_type

Definition at line 211 of file experimental/bits/fs_path.h.

## ◆ value_type

typedef char std::experimental::filesystem::v1::path::value_type

Definition at line 208 of file experimental/bits/fs_path.h.

## Constructor & Destructor Documentation

## ◆ path() [1/4]

template<typename _Source, typename _Require = __detail::_Path<_Source>>

std::experimental::filesystem::v1::path::path | ( | _Source const & | __source | ) |
| inline

Definition at line 223 of file experimental/bits/fs_path.h.

## ◆ path() [2/4]

template<typename _InputIterator, typename _Require = __detail::_Path<_InputIterator, _InputIterator>>

std::experimental::filesystem::v1::path::path | ( | _InputIterator | __first,
|  | _InputIterator | __last )
| inline

Definition at line 230 of file experimental/bits/fs_path.h.

## ◆ path() [3/4]

template<typename _Source, typename _Require = __detail::_Path<_Source>, typename _Require2 = __detail::__value_type_is_char<_Source>>

std::experimental::filesystem::v1::path::path | ( | _Source const & | __source,
|  | const locale & | __loc )
| inline

Definition at line 237 of file experimental/bits/fs_path.h.

## ◆ path() [4/4]

template<typename _InputIterator, typename _Require = __detail::_Path<_InputIterator, _InputIterator>, typename _Require2 = __detail::__value_type_is_char<_InputIterator>>

std::experimental::filesystem::v1::path::path | ( | _InputIterator | __first,
|  | _InputIterator | __last,
|  | const locale & | __loc )
| inline

Definition at line 245 of file experimental/bits/fs_path.h.

## Member Function Documentation

## ◆ append() [1/2]

template<typename _InputIterator>

__detail::_Path< _InputIterator, _InputIterator > & std::experimental::filesystem::v1::path::append | ( | _InputIterator | __first,
|  | _InputIterator | __last )
| inline

Definition at line 292 of file experimental/bits/fs_path.h.

## ◆ append() [2/2]

template<typename _Source>

__detail::_Path< _Source > & std::experimental::filesystem::v1::path::append | ( | _Source const & | __source | ) |
| inline

Definition at line 284 of file experimental/bits/fs_path.h.

## ◆ assign() [1/2]

template<typename _InputIterator>

__detail::_Path< _InputIterator, _InputIterator > & std::experimental::filesystem::v1::path::assign | ( | _InputIterator | __first,
|  | _InputIterator | __last )
| inline

Definition at line 270 of file experimental/bits/fs_path.h.

## ◆ assign() [2/2]

template<typename _Source>

__detail::_Path< _Source > & std::experimental::filesystem::v1::path::assign | ( | _Source const & | __source | ) |
| inline

Definition at line 265 of file experimental/bits/fs_path.h.

## ◆ c_str()

const value_type * std::experimental::filesystem::v1::path::c_str | ( |  | ) | const
| inlinenoexcept

Definition at line 340 of file experimental/bits/fs_path.h.

## ◆ clear()

void std::experimental::filesystem::v1::path::clear | ( |  | ) |
| inlinenoexcept

Definition at line 328 of file experimental/bits/fs_path.h.

## ◆ concat() [1/2]

template<typename _InputIterator>

__detail::_Path< _InputIterator, _InputIterator > & std::experimental::filesystem::v1::path::concat | ( | _InputIterator | __first,
|  | _InputIterator | __last )
| inline

Definition at line 323 of file experimental/bits/fs_path.h.

## ◆ concat() [2/2]

template<typename _Source>

__detail::_Path< _Source > & std::experimental::filesystem::v1::path::concat | ( | _Source const & | __x | ) |
| inline

Definition at line 315 of file experimental/bits/fs_path.h.

## ◆ empty()

bool std::experimental::filesystem::v1::path::empty | ( |  | ) | const
| inlinenodiscardnoexcept

Definition at line 402 of file experimental/bits/fs_path.h.

## ◆ is_relative()

bool std::experimental::filesystem::v1::path::is_relative | ( |  | ) | const
| inline

Definition at line 412 of file experimental/bits/fs_path.h.

## ◆ native()

const string_type & std::experimental::filesystem::v1::path::native | ( |  | ) | const
| inlinenoexcept

Definition at line 339 of file experimental/bits/fs_path.h.

## ◆ operator string_type()

std::experimental::filesystem::v1::path::operator string_type | ( |  | ) | const
| inline

Definition at line 341 of file experimental/bits/fs_path.h.

## ◆ operator+=()

template<typename _Source>

__detail::_Path< _Source > & std::experimental::filesystem::v1::path::operator+= | ( | _Source const & | __x | ) |
| inline

Definition at line 307 of file experimental/bits/fs_path.h.

## ◆ operator/=() [1/2]

template<typename _Source>

__detail::_Path< _Source > & std::experimental::filesystem::v1::path::operator/= | ( | _Source const & | __source | ) |
| inline

Definition at line 279 of file experimental/bits/fs_path.h.

## ◆ operator/=() [2/2]

path & std::experimental::filesystem::v1::path::operator/= | ( | const path & | __p | ) |
| inline

Definition at line 275 of file experimental/bits/fs_path.h.

## ◆ operator=()

template<typename _Source>

__detail::_Path< _Source > & std::experimental::filesystem::v1::path::operator= | ( | _Source const & | __source | ) |
| inline

Definition at line 260 of file experimental/bits/fs_path.h.

## Member Data Documentation

## ◆ preferred_separator

value_type std::experimental::filesystem::v1::path::preferred_separator
| staticconstexpr

Definition at line 209 of file experimental/bits/fs_path.h.

The documentation for this class was generated from the following file:

- experimental/bits/fs_path.h