path Class Reference

#include <toml.hpp>

Public Types
using	iterator = std::vector<path_component>::iterator
using	const_iterator = std::vector<path_component>::const_iterator

Public Member Functions
TOML_NODISCARD_CTOR	path () noexcept=default
TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION	path (std::string_view)
	~path () noexcept=default
TOML_NODISCARD_CTOR	path (const path &)=default
TOML_NODISCARD_CTOR	path (path &&) noexcept=default
TOML_PURE_INLINE_GETTER size_t	size () const noexcept
TOML_PURE_INLINE_GETTER	operator bool () const noexcept
TOML_PURE_INLINE_GETTER bool	empty () const noexcept
TOML_PURE_INLINE_GETTER path_component &	operator[] (size_t index) noexcept
TOML_PURE_INLINE_GETTER const path_component &	operator[] (size_t index) const noexcept
path &	operator= (const path &)=default
path &	operator= (path &&) noexcept=default
TOML_EXPORTED_MEMBER_FUNCTION path &	operator= (std::string_view)
TOML_ALWAYS_INLINE path &	assign (const path &p)
TOML_ALWAYS_INLINE path &	assign (path &&p) noexcept
TOML_ALWAYS_INLINE path &	assign (std::string_view str)
TOML_EXPORTED_MEMBER_FUNCTION path &	operator+= (const path &)
TOML_EXPORTED_MEMBER_FUNCTION path &	operator+= (path &&)
TOML_EXPORTED_MEMBER_FUNCTION path &	operator+= (std::string_view)
TOML_ALWAYS_INLINE path &	append (const path &p)
TOML_ALWAYS_INLINE path &	append (path &&p)
TOML_ALWAYS_INLINE path &	append (std::string_view str)
TOML_EXPORTED_MEMBER_FUNCTION path &	prepend (const path &)
TOML_EXPORTED_MEMBER_FUNCTION path &	prepend (path &&)
TOML_EXPORTED_MEMBER_FUNCTION path &	prepend (std::string_view)
TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION std::string	str () const
TOML_NODISCARD TOML_ALWAYS_INLINE	operator std::string () const
TOML_PURE_INLINE_GETTER iterator	begin () noexcept
TOML_PURE_INLINE_GETTER iterator	end () noexcept
TOML_PURE_INLINE_GETTER const_iterator	begin () const noexcept
TOML_PURE_INLINE_GETTER const_iterator	end () const noexcept
TOML_PURE_INLINE_GETTER const_iterator	cbegin () const noexcept
TOML_PURE_INLINE_GETTER const_iterator	cend () const noexcept
TOML_EXPORTED_MEMBER_FUNCTION void	clear () noexcept
TOML_EXPORTED_MEMBER_FUNCTION path &	truncate (size_t n)
TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path	truncated (size_t n) const
TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path	parent () const
TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path	leaf (size_t n=1) const
TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path	subpath (const_iterator start, const_iterator end) const
TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path	subpath (size_t start, size_t length) const

Friends
TOML_NODISCARD friend path	operator+ (const path &lhs, const path &rhs)
TOML_NODISCARD friend path	operator+ (const path &lhs, std::string_view rhs)
TOML_NODISCARD friend path	operator+ (std::string_view lhs, const path &rhs)
TOML_ALWAYS_INLINE friend std::ostream &	operator<< (std::ostream &os, const path &rhs)
TOML_PURE_INLINE_GETTER friend bool	operator== (const path &lhs, const path &rhs) noexcept
TOML_PURE_INLINE_GETTER friend bool	operator!= (const path &lhs, const path &rhs) noexcept
TOML_NODISCARD TOML_ALWAYS_INLINE friend bool	operator== (const path &lhs, std::string_view rhs)
TOML_NODISCARD TOML_ALWAYS_INLINE friend bool	operator== (std::string_view lhs, const path &rhs)
TOML_NODISCARD TOML_ALWAYS_INLINE friend bool	operator!= (const path &lhs, std::string_view rhs)
TOML_NODISCARD TOML_ALWAYS_INLINE friend bool	operator!= (std::string_view lhs, const path &rhs)

Member Typedef Documentation

const_iterator

using path::const_iterator = std::vector<path_component>::const_iterator

iterator

using path::iterator = std::vector<path_component>::iterator

Constructor & Destructor Documentation

path() [1/4]

TOML_NODISCARD_CTOR path::path ( )

defaultnoexcept

path() [2/4]

TOML_NODISCARD_CTOR TOML_EXPORTED_MEMBER_FUNCTION path::path ( std::string_view )

explicit

~path()

path::~path ( )

defaultnoexcept

path() [3/4]

TOML_NODISCARD_CTOR path::path ( const path & )

default

path() [4/4]

TOML_NODISCARD_CTOR path::path ( path && )

defaultnoexcept

Member Function Documentation

append() [1/3]

TOML_ALWAYS_INLINE path & path::append ( const path & p )

inline

append() [2/3]

TOML_ALWAYS_INLINE path & path::append ( path && p )

inline

append() [3/3]

TOML_ALWAYS_INLINE path & path::append ( std::string_view str )

inline

assign() [1/3]

TOML_ALWAYS_INLINE path & path::assign ( const path & p )

inline

assign() [2/3]

TOML_ALWAYS_INLINE path & path::assign ( path && p )

inlinenoexcept

assign() [3/3]

TOML_ALWAYS_INLINE path & path::assign ( std::string_view str )

inline

begin() [1/2]

TOML_PURE_INLINE_GETTER const_iterator path::begin ( ) const

inlinenoexcept

begin() [2/2]

TOML_PURE_INLINE_GETTER iterator path::begin ( )

inlinenoexcept

cbegin()

TOML_PURE_INLINE_GETTER const_iterator path::cbegin ( ) const

inlinenoexcept

cend()

TOML_PURE_INLINE_GETTER const_iterator path::cend ( ) const

inlinenoexcept

clear()

TOML_EXPORTED_MEMBER_FUNCTION void path::clear ( )

noexcept

empty()

TOML_PURE_INLINE_GETTER bool path::empty ( ) const

inlinenoexcept

end() [1/2]

TOML_PURE_INLINE_GETTER const_iterator path::end ( ) const

inlinenoexcept

end() [2/2]

TOML_PURE_INLINE_GETTER iterator path::end ( )

inlinenoexcept

leaf()

TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path path::leaf

(

size_t

n = 1

)

const

operator bool()

TOML_PURE_INLINE_GETTER path::operator bool ( ) const

inlineexplicitnoexcept

operator std::string()

TOML_NODISCARD TOML_ALWAYS_INLINE path::operator std::string ( ) const

inlineexplicit

operator+=() [1/3]

TOML_EXPORTED_MEMBER_FUNCTION path & path::operator+=

(

const path &

)

operator+=() [2/3]

TOML_EXPORTED_MEMBER_FUNCTION path & path::operator+=

(

path &&

)

operator+=() [3/3]

TOML_EXPORTED_MEMBER_FUNCTION path & path::operator+=

(

std::string_view

)

operator=() [1/3]

path & path::operator= ( const path & )

default

operator=() [2/3]

path & path::operator= ( path && )

defaultnoexcept

operator=() [3/3]

TOML_EXPORTED_MEMBER_FUNCTION path & path::operator=

(

std::string_view

)

operator[]() [1/2]

TOML_PURE_INLINE_GETTER const path_component & path::operator[] ( size_t index ) const

inlinenoexcept

operator[]() [2/2]

TOML_PURE_INLINE_GETTER path_component & path::operator[] ( size_t index )

inlinenoexcept

parent()

TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path path::parent

(

)

const

prepend() [1/3]

TOML_EXPORTED_MEMBER_FUNCTION path & path::prepend

(

const path &

)

prepend() [2/3]

TOML_EXPORTED_MEMBER_FUNCTION path & path::prepend

(

path &&

)

prepend() [3/3]

TOML_EXPORTED_MEMBER_FUNCTION path & path::prepend

(

std::string_view

)

size()

TOML_PURE_INLINE_GETTER size_t path::size ( ) const

inlinenoexcept

str()

TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION std::string path::str

(

)

const

subpath() [1/2]

TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path path::subpath	(	const_iterator	start,
		const_iterator	end ) const

subpath() [2/2]

TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path path::subpath	(	size_t	start,
		size_t	length ) const

truncate()

TOML_EXPORTED_MEMBER_FUNCTION path & path::truncate

(

size_t

n

)

truncated()

TOML_NODISCARD TOML_EXPORTED_MEMBER_FUNCTION path path::truncated

(

size_t

n

)

const

Friends And Related Symbol Documentation

operator!= [1/3]

TOML_PURE_INLINE_GETTER friend bool operator!= ( const path & lhs, const path & rhs )

friend

operator!= [2/3]

TOML_NODISCARD TOML_ALWAYS_INLINE friend bool operator!= ( const path & lhs, std::string_view rhs )

friend

operator!= [3/3]

TOML_NODISCARD TOML_ALWAYS_INLINE friend bool operator!= ( std::string_view lhs, const path & rhs )

friend

operator+ [1/3]

TOML_NODISCARD friend path operator+ ( const path & lhs, const path & rhs )

friend

operator+ [2/3]

TOML_NODISCARD friend path operator+ ( const path & lhs, std::string_view rhs )

friend

operator+ [3/3]

TOML_NODISCARD friend path operator+ ( std::string_view lhs, const path & rhs )

friend

operator<<

TOML_ALWAYS_INLINE friend std::ostream & operator<< ( std::ostream & os, const path & rhs )

friend

operator== [1/3]

TOML_PURE_INLINE_GETTER friend bool operator== ( const path & lhs, const path & rhs )

friend

operator== [2/3]

TOML_NODISCARD TOML_ALWAYS_INLINE friend bool operator== ( const path & lhs, std::string_view rhs )

friend

operator== [3/3]

TOML_NODISCARD TOML_ALWAYS_INLINE friend bool operator== ( std::string_view lhs, const path & rhs )

friend

---

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

• src/lib/toml.hpp