libstdc++
std::basic_string< _CharT, _Traits, _Alloc > Class Template Reference

Public Types

typedef _Alloc allocator_type
 
typedef __gnu_cxx::__normal_iterator< const_pointer, basic_stringconst_iterator
 
typedef _CharT_alloc_traits::const_pointer const_pointer
 
typedef const value_type & const_reference
 
typedef std::reverse_iterator< const_iterator > const_reverse_iterator
 
typedef _CharT_alloc_traits::difference_type difference_type
 
typedef __gnu_cxx::__normal_iterator< pointer, basic_stringiterator
 
typedef _CharT_alloc_traits::pointer pointer
 
typedef value_type & reference
 
typedef std::reverse_iterator< iterator > reverse_iterator
 
typedef _CharT_alloc_traits::size_type size_type
 
typedef _Traits traits_type
 
typedef _Traits::char_type value_type
 

Public Member Functions

 basic_string () noexcept
 
template<class _InputIterator >
 basic_string (_InputIterator __beg, _InputIterator __end, const _Alloc &__a=_Alloc())
 
 basic_string (basic_string &&__str) noexcept
 
 basic_string (basic_string &&__str, const _Alloc &__a)
 
 basic_string (const _Alloc &__a)
 
 basic_string (const _CharT *__s, const _Alloc &__a=_Alloc())
 
 basic_string (const _CharT *__s, size_type __n, const _Alloc &__a=_Alloc())
 
template<typename _Tp , typename = _If_sv<_Tp, void>>
 basic_string (const _Tp &__t, const _Alloc &__a=_Alloc())
 
template<typename _Tp , typename = _If_sv<_Tp, void>>
 basic_string (const _Tp &__t, size_type __pos, size_type __n, const _Alloc &__a=_Alloc())
 
 basic_string (const basic_string &__str)
 
 basic_string (const basic_string &__str, const _Alloc &__a)
 
 basic_string (const basic_string &__str, size_type __pos, const _Alloc &__a=_Alloc())
 
 basic_string (const basic_string &__str, size_type __pos, size_type __n)
 
 basic_string (const basic_string &__str, size_type __pos, size_type __n, const _Alloc &__a)
 
 basic_string (initializer_list< _CharT > __l, const _Alloc &__a=_Alloc())
 
 basic_string (size_type __n, _CharT __c, const _Alloc &__a=_Alloc())
 
 ~basic_string () noexcept
 
template<typename _InputIterator >
basic_string< _CharT, _Traits, _Alloc > & _M_replace_dispatch (iterator __i1, iterator __i2, _InputIterator __k1, _InputIterator __k2, __false_type)
 
template<typename _InIterator >
_CharT * _S_construct (_InIterator __beg, _InIterator __end, const _Alloc &__a, forward_iterator_tag)
 
template<class _InputIterator >
basic_stringappend (_InputIterator __first, _InputIterator __last)
 
basic_stringappend (const _CharT *__s)
 
basic_stringappend (const _CharT *__s, size_type __n)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > append (const _Tp &__svt)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > append (const _Tp &__svt, size_type __pos, size_type __n=npos)
 
basic_stringappend (const basic_string &__str)
 
basic_stringappend (const basic_string &__str, size_type __pos, size_type __n=npos)
 
basic_stringappend (initializer_list< _CharT > __l)
 
basic_stringappend (size_type __n, _CharT __c)
 
template<class _InputIterator >
basic_stringassign (_InputIterator __first, _InputIterator __last)
 
basic_stringassign (basic_string &&__str) noexcept(allocator_traits< _Alloc >::is_always_equal::value)
 
basic_stringassign (const _CharT *__s)
 
basic_stringassign (const _CharT *__s, size_type __n)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > assign (const _Tp &__svt)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > assign (const _Tp &__svt, size_type __pos, size_type __n=npos)
 
basic_stringassign (const basic_string &__str)
 
basic_stringassign (const basic_string &__str, size_type __pos, size_type __n=npos)
 
basic_stringassign (initializer_list< _CharT > __l)
 
basic_stringassign (size_type __n, _CharT __c)
 
reference at (size_type __n)
 
const_reference at (size_type __n) const
 
reference back ()
 
const_reference back () const noexcept
 
iterator begin ()
 
const_iterator begin () const noexcept
 
const _CharT * c_str () const noexcept
 
size_type capacity () const noexcept
 
const_iterator cbegin () const noexcept
 
const_iterator cend () const noexcept
 
void clear () noexcept
 
int compare (const _CharT *__s) const noexcept
 
template<typename _Tp >
_If_sv< _Tp, int > compare (const _Tp &__svt) const noexcept(is_same< _Tp, __sv_type >::value)
 
int compare (const basic_string &__str) const
 
template<typename _Tp >
_If_sv< _Tp, int > compare (size_type __pos, size_type __n, const _Tp &__svt) const noexcept(is_same< _Tp, __sv_type >::value)
 
int compare (size_type __pos, size_type __n, const basic_string &__str) const
 
int compare (size_type __pos, size_type __n1, const _CharT *__s) const
 
int compare (size_type __pos, size_type __n1, const _CharT *__s, size_type __n2) const
 
template<typename _Tp >
_If_sv< _Tp, int > compare (size_type __pos1, size_type __n1, const _Tp &__svt, size_type __pos2, size_type __n2=npos) const noexcept(is_same< _Tp, __sv_type >::value)
 
int compare (size_type __pos1, size_type __n1, const basic_string &__str, size_type __pos2, size_type __n2=npos) const
 
size_type copy (_CharT *__s, size_type __n, size_type __pos=0) const
 
const_reverse_iterator crbegin () const noexcept
 
const_reverse_iterator crend () const noexcept
 
const _CharT * data () const noexcept
 
_CharT * data () noexcept
 
bool empty () const noexcept
 
iterator end ()
 
const_iterator end () const noexcept
 
iterator erase (iterator __first, iterator __last)
 
iterator erase (iterator __position)
 
basic_stringerase (size_type __pos=0, size_type __n=npos)
 
size_type find (_CharT __c, size_type __pos=0) const noexcept
 
size_type find (const _CharT *__s, size_type __pos, size_type __n) const noexcept
 
size_type find (const _CharT *__s, size_type __pos=0) const noexcept
 
template<typename _Tp >
_If_sv< _Tp, size_type > find (const _Tp &__svt, size_type __pos=0) const noexcept(is_same< _Tp, __sv_type >::value)
 
size_type find (const basic_string &__str, size_type __pos=0) const noexcept
 
size_type find_first_not_of (_CharT __c, size_type __pos=0) const noexcept
 
size_type find_first_not_of (const _CharT *__s, size_type __pos, size_type __n) const noexcept
 
size_type find_first_not_of (const _CharT *__s, size_type __pos=0) const noexcept
 
template<typename _Tp >
_If_sv< _Tp, size_type > find_first_not_of (const _Tp &__svt, size_type __pos=0) const noexcept(is_same< _Tp, __sv_type >::value)
 
size_type find_first_not_of (const basic_string &__str, size_type __pos=0) const noexcept
 
size_type find_first_of (_CharT __c, size_type __pos=0) const noexcept
 
size_type find_first_of (const _CharT *__s, size_type __pos, size_type __n) const noexcept
 
size_type find_first_of (const _CharT *__s, size_type __pos=0) const noexcept
 
template<typename _Tp >
_If_sv< _Tp, size_type > find_first_of (const _Tp &__svt, size_type __pos=0) const noexcept(is_same< _Tp, __sv_type >::value)
 
size_type find_first_of (const basic_string &__str, size_type __pos=0) const noexcept
 
size_type find_last_not_of (_CharT __c, size_type __pos=npos) const noexcept
 
size_type find_last_not_of (const _CharT *__s, size_type __pos, size_type __n) const noexcept
 
size_type find_last_not_of (const _CharT *__s, size_type __pos=npos) const noexcept
 
template<typename _Tp >
_If_sv< _Tp, size_type > find_last_not_of (const _Tp &__svt, size_type __pos=npos) const noexcept(is_same< _Tp, __sv_type >::value)
 
size_type find_last_not_of (const basic_string &__str, size_type __pos=npos) const noexcept
 
size_type find_last_of (_CharT __c, size_type __pos=npos) const noexcept
 
size_type find_last_of (const _CharT *__s, size_type __pos, size_type __n) const noexcept
 
size_type find_last_of (const _CharT *__s, size_type __pos=npos) const noexcept
 
template<typename _Tp >
_If_sv< _Tp, size_type > find_last_of (const _Tp &__svt, size_type __pos=npos) const noexcept(is_same< _Tp, __sv_type >::value)
 
size_type find_last_of (const basic_string &__str, size_type __pos=npos) const noexcept
 
reference front ()
 
const_reference front () const noexcept
 
allocator_type get_allocator () const noexcept
 
iterator insert (iterator __p, _CharT __c)
 
template<class _InputIterator >
void insert (iterator __p, _InputIterator __beg, _InputIterator __end)
 
void insert (iterator __p, initializer_list< _CharT > __l)
 
void insert (iterator __p, size_type __n, _CharT __c)
 
basic_stringinsert (size_type __pos, const _CharT *__s)
 
basic_stringinsert (size_type __pos, const _CharT *__s, size_type __n)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > insert (size_type __pos, const _Tp &__svt)
 
basic_stringinsert (size_type __pos, size_type __n, _CharT __c)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > insert (size_type __pos1, const _Tp &__svt, size_type __pos2, size_type __n=npos)
 
basic_stringinsert (size_type __pos1, const basic_string &__str)
 
basic_stringinsert (size_type __pos1, const basic_string &__str, size_type __pos2, size_type __n=npos)
 
size_type length () const noexcept
 
size_type max_size () const noexcept
 
 operator __sv_type () const noexcept
 
basic_stringoperator+= (_CharT __c)
 
basic_stringoperator+= (const _CharT *__s)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > operator+= (const _Tp &__svt)
 
basic_stringoperator+= (const basic_string &__str)
 
basic_stringoperator+= (initializer_list< _CharT > __l)
 
basic_stringoperator= (_CharT __c)
 
basic_stringoperator= (basic_string &&__str) noexcept(/*conditional */)
 
basic_stringoperator= (const _CharT *__s)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > operator= (const _Tp &__svt)
 
basic_stringoperator= (const basic_string &__str)
 
basic_stringoperator= (initializer_list< _CharT > __l)
 
reference operator[] (size_type __pos)
 
const_reference operator[] (size_type __pos) const noexcept
 
void pop_back ()
 
void push_back (_CharT __c)
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const noexcept
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const noexcept
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > replace (const_iterator __i1, const_iterator __i2, const _Tp &__svt)
 
basic_stringreplace (iterator __i1, iterator __i2, _CharT *__k1, _CharT *__k2)
 
template<class _InputIterator >
basic_stringreplace (iterator __i1, iterator __i2, _InputIterator __k1, _InputIterator __k2)
 
basic_stringreplace (iterator __i1, iterator __i2, const _CharT *__k1, const _CharT *__k2)
 
basic_stringreplace (iterator __i1, iterator __i2, const _CharT *__s)
 
basic_stringreplace (iterator __i1, iterator __i2, const _CharT *__s, size_type __n)
 
basic_stringreplace (iterator __i1, iterator __i2, const basic_string &__str)
 
basic_stringreplace (iterator __i1, iterator __i2, const_iterator __k1, const_iterator __k2)
 
basic_stringreplace (iterator __i1, iterator __i2, initializer_list< _CharT > __l)
 
basic_stringreplace (iterator __i1, iterator __i2, iterator __k1, iterator __k2)
 
basic_stringreplace (iterator __i1, iterator __i2, size_type __n, _CharT __c)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > replace (size_type __pos, size_type __n, const _Tp &__svt)
 
basic_stringreplace (size_type __pos, size_type __n, const basic_string &__str)
 
basic_stringreplace (size_type __pos, size_type __n1, const _CharT *__s)
 
basic_stringreplace (size_type __pos, size_type __n1, const _CharT *__s, size_type __n2)
 
basic_stringreplace (size_type __pos, size_type __n1, size_type __n2, _CharT __c)
 
template<typename _Tp >
_If_sv< _Tp, basic_string & > replace (size_type __pos1, size_type __n1, const _Tp &__svt, size_type __pos2, size_type __n2=npos)
 
basic_stringreplace (size_type __pos1, size_type __n1, const basic_string &__str, size_type __pos2, size_type __n2=npos)
 
void reserve ()
 
void reserve (size_type __res_arg)
 
void resize (size_type __n)
 
void resize (size_type __n, _CharT __c)
 
size_type rfind (_CharT __c, size_type __pos=npos) const noexcept
 
size_type rfind (const _CharT *__s, size_type __pos, size_type __n) const noexcept
 
size_type rfind (const _CharT *__s, size_type __pos=npos) const noexcept
 
template<typename _Tp >
_If_sv< _Tp, size_type > rfind (const _Tp &__svt, size_type __pos=npos) const noexcept(is_same< _Tp, __sv_type >::value)
 
size_type rfind (const basic_string &__str, size_type __pos=npos) const noexcept
 
void shrink_to_fit () noexcept
 
size_type size () const noexcept
 
basic_string substr (size_type __pos=0, size_type __n=npos) const
 
void swap (basic_string &__s) noexcept(/*conditional */)
 

Static Public Attributes

static const size_type npos
 

Protected Types

typedef iterator __const_iterator
 

Detailed Description

template<typename _CharT, typename _Traits, typename _Alloc>
class std::basic_string< _CharT, _Traits, _Alloc >

Managing sequences of characters and character-like objects.

Template Parameters
_CharTType of character
_TraitsTraits for character type, defaults to char_traits<_CharT>.
_AllocAllocator type, defaults to allocator<_CharT>.

Meets the requirements of a container, a reversible container, and a sequence. Of the optional sequence requirements, only push_back, at, and array access are supported.

Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Documentation? What's that? Nathan Myers ncm@c.nosp@m.antr.nosp@m.ip.or.nosp@m.g.

A string looks like this:

[_Rep]
_M_length
[basic_string<char_type>] _M_capacity
_M_dataplus _M_refcount
_M_p ----------------> unnamed array of char_type

Where the _M_p points to the first character in the string, and you cast it to a pointer-to-_Rep and subtract 1 to get a pointer to the header.

This approach has the enormous advantage that a string object requires only one allocation. All the ugliness is confined within a single pair of inline functions, which each compile to a single add instruction: _Rep::_M_data(), and string::_M_rep(); and the allocation function which gets a block of raw bytes and with room enough and constructs a _Rep object at the front.

The reason you want _M_data pointing to the character array and not the _Rep is so that the debugger can see the string contents. (Probably we should add a non-inline member to get the _Rep for the debugger to use, so users can check the actual string length.)

Note that the _Rep object is a POD so that you can have a static empty string _Rep object already constructed before static constructors have run. The reference-count encoding is chosen so that a 0 indicates one reference, so you never try to destroy the empty-string _Rep object.

All but the last paragraph is considered pretty conventional for a C++ string implementation.

Definition at line 3173 of file basic_string.h.

Constructor & Destructor Documentation

◆ basic_string() [1/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( )
inlinenoexcept

Default constructor creates an empty string.

Definition at line 3580 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::substr().

◆ basic_string() [2/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const _Alloc &  __a)
inlineexplicit

Construct an empty string using allocator a.

Definition at line 3593 of file basic_string.h.

◆ basic_string() [3/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const basic_string< _CharT, _Traits, _Alloc > &  __str)
inline

Construct string with copy of value of str.

Parameters
__strSource string.

Definition at line 3602 of file basic_string.h.

◆ basic_string() [4/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos,
const _Alloc &  __a = _Alloc() 
)

Construct string as copy of a substring.

Parameters
__strSource string.
__posIndex of first character to copy from.
__aAllocator to use.

Definition at line 641 of file basic_string.tcc.

◆ basic_string() [5/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos,
size_type  __n 
)

Construct string as copy of a substring.

Parameters
__strSource string.
__posIndex of first character to copy from.
__nNumber of characters to copy.

Definition at line 651 of file basic_string.tcc.

◆ basic_string() [6/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos,
size_type  __n,
const _Alloc &  __a 
)

Construct string as copy of a substring.

Parameters
__strSource string.
__posIndex of first character to copy from.
__nNumber of characters to copy.
__aAllocator to use.

Definition at line 661 of file basic_string.tcc.

◆ basic_string() [7/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const _CharT *  __s,
size_type  __n,
const _Alloc &  __a = _Alloc() 
)
inline

Construct string initialized by a character array.

Parameters
__sSource character array.
__nNumber of characters to copy.
__aAllocator to use (default is default allocator).

NB: __s must have at least __n characters, '\0' has no special meaning.

Definition at line 3646 of file basic_string.h.

◆ basic_string() [8/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const _CharT *  __s,
const _Alloc &  __a = _Alloc() 
)
inline

Construct string as copy of a C string.

Parameters
__sSource C string.
__aAllocator to use (default is default allocator).

Definition at line 3661 of file basic_string.h.

◆ basic_string() [9/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( size_type  __n,
_CharT  __c,
const _Alloc &  __a = _Alloc() 
)
inline

Construct string as multiple characters.

Parameters
__nNumber of characters.
__cCharacter to use.
__aAllocator to use (default is default allocator).

Definition at line 3672 of file basic_string.h.

◆ basic_string() [10/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( basic_string< _CharT, _Traits, _Alloc > &&  __str)
inlinenoexcept

Move construct string.

Parameters
__strSource string.

The newly-created string contains the exact contents of __str. __str is a valid, but unspecified string.

Definition at line 3684 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::get_allocator().

◆ basic_string() [11/14]

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( initializer_list< _CharT >  __l,
const _Alloc &  __a = _Alloc() 
)
inline

Construct string from an initializer list.

Parameters
__lstd::initializer_list of characters.
__aAllocator to use (default is default allocator).

Definition at line 3702 of file basic_string.h.

◆ basic_string() [12/14]

template<typename _CharT , typename _Traits , typename _Alloc >
template<class _InputIterator >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( _InputIterator  __beg,
_InputIterator  __end,
const _Alloc &  __a = _Alloc() 
)
inline

Construct string as copy of a range.

Parameters
__begStart of range.
__endEnd of range.
__aAllocator to use (default is default allocator).

Definition at line 3733 of file basic_string.h.

◆ basic_string() [13/14]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp , typename = _If_sv<_Tp, void>>
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const _Tp &  __t,
size_type  __pos,
size_type  __n,
const _Alloc &  __a = _Alloc() 
)
inline

Construct string from a substring of a string_view.

Parameters
__tSource object convertible to string view.
__posThe index of the first character to copy from __t.
__nThe number of characters to copy from __t.
__aAllocator to use.

Definition at line 3747 of file basic_string.h.

◆ basic_string() [14/14]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp , typename = _If_sv<_Tp, void>>
std::basic_string< _CharT, _Traits, _Alloc >::basic_string ( const _Tp &  __t,
const _Alloc &  __a = _Alloc() 
)
inlineexplicit

Construct string from a string_view.

Parameters
__tSource object convertible to string view.
__aAllocator to use (default is default allocator).

Definition at line 3758 of file basic_string.h.

◆ ~basic_string()

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::~basic_string ( )
inlinenoexcept

Destroy the string instance.

Definition at line 3765 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::get_allocator().

Member Function Documentation

◆ append() [1/9]

template<typename _CharT , typename _Traits , typename _Alloc >
template<class _InputIterator >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::append ( _InputIterator  __first,
_InputIterator  __last 
)
inline

Append a range of characters.

Parameters
__firstIterator referencing the first character to append.
__lastIterator marking the end of the range.
Returns
Reference to this string.

Appends characters in the range [__first,__last) to this string.

Definition at line 4338 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ append() [2/9]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::append ( const _CharT *  __s)
inline

Append a C string.

Parameters
__sThe C string to append.
Returns
Reference to this string.

Definition at line 4300 of file basic_string.h.

◆ append() [3/9]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc > & std::basic_string< _CharT, _Traits, _Alloc >::append ( const _CharT *  __s,
size_type  __n 
)

Append a C substring.

Parameters
__sThe C string to append.
__nThe number of characters to append.
Returns
Reference to this string.

Definition at line 728 of file basic_string.tcc.

◆ append() [4/9]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::append ( const _Tp &  __svt)
inline

Append a string_view.

Parameters
__svtThe object convertible to string_view to be appended.
Returns
Reference to this string.

Definition at line 4349 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::append().

◆ append() [5/9]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::append ( const _Tp &  __svt,
size_type  __pos,
size_type  __n = npos 
)
inline

Append a range of characters from a string_view.

Parameters
__svtThe object convertible to string_view to be appended from.
__posThe position in the string_view to append from.
__nThe number of characters to append from the string_view.
Returns
Reference to this string.

Definition at line 4365 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::append().

◆ append() [6/9]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc > & std::basic_string< _CharT, _Traits, _Alloc >::append ( const basic_string< _CharT, _Traits, _Alloc > &  __str)

Append a string to this string.

Parameters
__strThe string to append.
Returns
Reference to this string.

Definition at line 755 of file basic_string.tcc.

References std::basic_string< _CharT, _Traits, _Alloc >::size(), and std::size().

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::append(), and std::basic_string< _CharT, _Traits, _Alloc >::operator+=().

◆ append() [7/9]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc > & std::basic_string< _CharT, _Traits, _Alloc >::append ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos,
size_type  __n = npos 
)

Append a substring.

Parameters
__strThe string to append.
__posIndex of the first character of str to append.
__nThe number of characters to append.
Returns
Reference to this string.
Exceptions
std::out_of_rangeif __pos is not a valid index.

This function appends __n characters from __str starting at __pos to this string. If __n is is larger than the number of available characters in __str, the remainder of __str is appended.

Definition at line 772 of file basic_string.tcc.

References std::size().

◆ append() [8/9]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::append ( initializer_list< _CharT >  __l)
inline

Append an initializer_list of characters.

Parameters
__lThe initializer_list of characters to append.
Returns
Reference to this string.

Definition at line 4324 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::append().

◆ append() [9/9]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc > & std::basic_string< _CharT, _Traits, _Alloc >::append ( size_type  __n,
_CharT  __c 
)

Append multiple characters.

Parameters
__nThe number of characters to append.
__cThe character to use.
Returns
Reference to this string.

Appends __n copies of __c to this string.

Definition at line 711 of file basic_string.tcc.

References std::size().

◆ assign() [1/10]

template<typename _CharT , typename _Traits , typename _Alloc >
template<class _InputIterator >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::assign ( _InputIterator  __first,
_InputIterator  __last 
)
inline

Set value to a range of characters.

Parameters
__firstIterator referencing the first character to append.
__lastIterator marking the end of the range.
Returns
Reference to this string.

Sets value of string to characters in the range [__first,__last).

Definition at line 4485 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ assign() [2/10]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::assign ( basic_string< _CharT, _Traits, _Alloc > &&  __str)
inlinenoexcept

Set value to contents of another string.

Parameters
__strSource string to use.
Returns
Reference to this string.

This function sets this string to the exact contents of __str. __str is a valid, but unspecified string.

Definition at line 4406 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::swap().

◆ assign() [3/10]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::assign ( const _CharT *  __s)
inline

Set value to contents of a C string.

Parameters
__sThe C string to use.
Returns
Reference to this string.

This function sets the value of this string to the value of __s. The data is copied, so there is no dependence on __s once the function returns.

Definition at line 4456 of file basic_string.h.

◆ assign() [4/10]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc > & std::basic_string< _CharT, _Traits, _Alloc >::assign ( const _CharT *  __s,
size_type  __n 
)

Set value to a C substring.

Parameters
__sThe C string to use.
__nNumber of characters to use.
Returns
Reference to this string.

This function sets the value of this string to the first __n characters of __s. If __n is is larger than the number of available characters in __s, the remainder of __s is used.

Definition at line 689 of file basic_string.tcc.

◆ assign() [5/10]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::assign ( const _Tp &  __svt)
inline

Set value from a string_view.

Parameters
__svtThe source object convertible to string_view.
Returns
Reference to this string.

Definition at line 4507 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ assign() [6/10]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::assign ( const _Tp &  __svt,
size_type  __pos,
size_type  __n = npos 
)
inline

Set value from a range of characters in a string_view.

Parameters
__svtThe source object convertible to string_view.
__posThe position in the string_view to assign from.
__nThe number of characters to assign.
Returns
Reference to this string.

Definition at line 4522 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ assign() [7/10]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc > & std::basic_string< _CharT, _Traits, _Alloc >::assign ( const basic_string< _CharT, _Traits, _Alloc > &  __str)

◆ assign() [8/10]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::assign ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos,
size_type  __n = npos 
)
inline

Set value to a substring of a string.

Parameters
__strThe string to use.
__posIndex of the first character of str.
__nNumber of characters to use.
Returns
Reference to this string.
Exceptions
std::out_of_rangeif pos is not a valid index.

This function sets this string to the substring of __str consisting of __n characters at __pos. If __n is is larger than the number of available characters in __str, the remainder of __str is used.

Definition at line 4428 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ assign() [9/10]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::assign ( initializer_list< _CharT >  __l)
inline

Set value to an initializer_list of characters.

Parameters
__lThe initializer_list of characters to assign.
Returns
Reference to this string.

Definition at line 4495 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ assign() [10/10]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::assign ( size_type  __n,
_CharT  __c 
)
inline

Set value to multiple characters.

Parameters
__nLength of the resulting string.
__cThe character to use.
Returns
Reference to this string.

This function sets the value of this string to __n copies of character __c.

Definition at line 4472 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ at() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
reference std::basic_string< _CharT, _Traits, _Alloc >::at ( size_type  __n)
inline

Provides access to the data contained in the string.

Parameters
__nThe index of the character to access.
Returns
Read/write reference to the character.
Exceptions
std::out_of_rangeIf n is an invalid index.

This function provides for safer data access. The parameter is first checked that it is in the range of the string. The function throws out_of_range if the check fails. Success results in unsharing the string.

Definition at line 4150 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ at() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const_reference std::basic_string< _CharT, _Traits, _Alloc >::at ( size_type  __n) const
inline

Provides access to the data contained in the string.

Parameters
__nThe index of the character to access.
Returns
Read-only (const) reference to the character.
Exceptions
std::out_of_rangeIf n is an invalid index.

This function provides for safer data access. The parameter is first checked that it is in the range of the string. The function throws out_of_range if the check fails.

Definition at line 4128 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ back() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
reference std::basic_string< _CharT, _Traits, _Alloc >::back ( )
inline

Returns a read/write reference to the data at the last element of the string.

Definition at line 4189 of file basic_string.h.

◆ back() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const_reference std::basic_string< _CharT, _Traits, _Alloc >::back ( ) const
inlinenoexcept

Returns a read-only (constant) reference to the data at the last element of the string.

Definition at line 4200 of file basic_string.h.

◆ begin() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
iterator std::basic_string< _CharT, _Traits, _Alloc >::begin ( )
inline

Returns a read/write iterator that points to the first character in the string. Unshares the string.

Definition at line 3851 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::crend(), std::regex_match(), std::regex_replace(), std::regex_search(), std::basic_string< _CharT, _Traits, _Alloc >::rend(), and std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ begin() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const_iterator std::basic_string< _CharT, _Traits, _Alloc >::begin ( ) const
inlinenoexcept

Returns a read-only (constant) iterator that points to the first character in the string.

Definition at line 3862 of file basic_string.h.

◆ c_str()

template<typename _CharT , typename _Traits , typename _Alloc >
const _CharT* std::basic_string< _CharT, _Traits, _Alloc >::c_str ( ) const
inlinenoexcept

◆ capacity()

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::capacity ( ) const
inlinenoexcept

Returns the total number of characters that the string can hold before needing to allocate more memory.

Definition at line 4017 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::push_back().

◆ cbegin()

template<typename _CharT , typename _Traits , typename _Alloc >
const_iterator std::basic_string< _CharT, _Traits, _Alloc >::cbegin ( ) const
inlinenoexcept

Returns a read-only (constant) iterator that points to the first character in the string.

Definition at line 3926 of file basic_string.h.

◆ cend()

template<typename _CharT , typename _Traits , typename _Alloc >
const_iterator std::basic_string< _CharT, _Traits, _Alloc >::cend ( ) const
inlinenoexcept

Returns a read-only (constant) iterator that points one past the last character in the string.

Definition at line 3934 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ clear()

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::clear ( )
inlinenoexcept

Erases the string, making it empty.

Definition at line 4052 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::get_allocator().

Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::setbuf().

◆ compare() [1/9]

template<typename _CharT , typename _Traits , typename _Alloc >
int std::basic_string< _CharT, _Traits, _Alloc >::compare ( const _CharT *  __s) const
noexcept

Compare to a C string.

Parameters
__sC string to compare against.
Returns
Integer < 0, 0, or > 0.

Returns an integer < 0 if this string is ordered before __s, 0 if their values are equivalent, or > 0 if this string is ordered after __s. Determines the effective length rlen of the strings to compare as the smallest of size() and the length of a string constructed from __s. The function then compares the two strings by calling traits::compare(data(),s,rlen). If the result of the comparison is nonzero returns it, otherwise the shorter one is ordered first.

Definition at line 1437 of file basic_string.tcc.

◆ compare() [2/9]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, int> std::basic_string< _CharT, _Traits, _Alloc >::compare ( const _Tp &  __svt) const
inlinenoexcept

Compare to a string_view.

Parameters
__svtAn object convertible to string_view to compare against.
Returns
Integer < 0, 0, or > 0.

Definition at line 5830 of file basic_string.h.

References std::min(), and std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ compare() [3/9]

template<typename _CharT , typename _Traits , typename _Alloc >
int std::basic_string< _CharT, _Traits, _Alloc >::compare ( const basic_string< _CharT, _Traits, _Alloc > &  __str) const
inline

Compare to a string.

Parameters
__strString to compare against.
Returns
Integer < 0, 0, or > 0.

Returns an integer < 0 if this string is ordered before __str, 0 if their values are equivalent, or > 0 if this string is ordered after __str. Determines the effective length rlen of the strings to compare as the smallest of size() and str.size(). The function then compares the two strings by calling traits::compare(data(), str.data(),rlen). If the result of the comparison is nonzero returns it, otherwise the shorter one is ordered first.

Definition at line 5810 of file basic_string.h.

References std::min(), and std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ compare() [4/9]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, int> std::basic_string< _CharT, _Traits, _Alloc >::compare ( size_type  __pos,
size_type  __n,
const _Tp &  __svt 
) const
inlinenoexcept

Compare to a string_view.

Parameters
__posA position in the string to start comparing from.
__nThe number of characters to compare.
__svtAn object convertible to string_view to compare against.
Returns
Integer < 0, 0, or > 0.

Definition at line 5854 of file basic_string.h.

◆ compare() [5/9]

template<typename _CharT , typename _Traits , typename _Alloc >
int std::basic_string< _CharT, _Traits, _Alloc >::compare ( size_type  __pos,
size_type  __n,
const basic_string< _CharT, _Traits, _Alloc > &  __str 
) const

Compare substring to a string.

Parameters
__posIndex of first character of substring.
__nNumber of characters in substring.
__strString to compare against.
Returns
Integer < 0, 0, or > 0.

Form the substring of this string from the __n characters starting at __pos. Returns an integer < 0 if the substring is ordered before __str, 0 if their values are equivalent, or > 0 if the substring is ordered after __str. Determines the effective length rlen of the strings to compare as the smallest of the length of the substring and __str.size(). The function then compares the two strings by calling traits::compare(substring.data(),str.data(),rlen). If the result of the comparison is nonzero returns it, otherwise the shorter one is ordered first.

Definition at line 1404 of file basic_string.tcc.

References std::basic_string< _CharT, _Traits, _Alloc >::data(), std::min(), and std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ compare() [6/9]

template<typename _CharT , typename _Traits , typename _Alloc >
int std::basic_string< _CharT, _Traits, _Alloc >::compare ( size_type  __pos,
size_type  __n1,
const _CharT *  __s 
) const

Compare substring to a C string.

Parameters
__posIndex of first character of substring.
__n1Number of characters in substring.
__sC string to compare against.
Returns
Integer < 0, 0, or > 0.

Form the substring of this string from the __n1 characters starting at pos. Returns an integer < 0 if the substring is ordered before __s, 0 if their values are equivalent, or > 0 if the substring is ordered after __s. Determines the effective length rlen of the strings to compare as the smallest of the length of the substring and the length of a string constructed from __s. The function then compares the two string by calling traits::compare(substring.data(),__s,rlen). If the result of the comparison is nonzero returns it, otherwise the shorter one is ordered first.

Definition at line 1452 of file basic_string.tcc.

◆ compare() [7/9]

template<typename _CharT , typename _Traits , typename _Alloc >
int std::basic_string< _CharT, _Traits, _Alloc >::compare ( size_type  __pos,
size_type  __n1,
const _CharT *  __s,
size_type  __n2 
) const

Compare substring against a character array.

Parameters
__posIndex of first character of substring.
__n1Number of characters in substring.
__scharacter array to compare against.
__n2Number of characters of s.
Returns
Integer < 0, 0, or > 0.

Form the substring of this string from the __n1 characters starting at __pos. Form a string from the first __n2 characters of __s. Returns an integer < 0 if this substring is ordered before the string from __s, 0 if their values are equivalent, or > 0 if this substring is ordered after the string from __s. Determines the effective length rlen of the strings to compare as the smallest of the length of the substring and __n2. The function then compares the two strings by calling traits::compare(substring.data(),s,rlen). If the result of the comparison is nonzero returns it, otherwise the shorter one is ordered first.

NB: s must have at least n2 characters, '\0' has no special meaning.

Definition at line 1468 of file basic_string.tcc.

◆ compare() [8/9]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, int> std::basic_string< _CharT, _Traits, _Alloc >::compare ( size_type  __pos1,
size_type  __n1,
const _Tp &  __svt,
size_type  __pos2,
size_type  __n2 = npos 
) const
inlinenoexcept

Compare to a string_view.

Parameters
__pos1A position in the string to start comparing from.
__n1The number of characters to compare.
__svtAn object convertible to string_view to compare against.
__pos2A position in the string_view to start comparing from.
__n2The number of characters to compare.
Returns
Integer < 0, 0, or > 0.

Definition at line 5873 of file basic_string.h.

◆ compare() [9/9]

template<typename _CharT , typename _Traits , typename _Alloc >
int std::basic_string< _CharT, _Traits, _Alloc >::compare ( size_type  __pos1,
size_type  __n1,
const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos2,
size_type  __n2 = npos 
) const

Compare substring to a substring.

Parameters
__pos1Index of first character of substring.
__n1Number of characters in substring.
__strString to compare against.
__pos2Index of first character of substring of str.
__n2Number of characters in substring of str.
Returns
Integer < 0, 0, or > 0.

Form the substring of this string from the __n1 characters starting at __pos1. Form the substring of __str from the __n2 characters starting at __pos2. Returns an integer < 0 if this substring is ordered before the substring of __str, 0 if their values are equivalent, or > 0 if this substring is ordered after the substring of __str. Determines the effective length rlen of the strings to compare as the smallest of the lengths of the substrings. The function then compares the two strings by calling traits::compare(substring.data(),str.substr(pos2,n2).data(),rlen). If the result of the comparison is nonzero returns it, otherwise the shorter one is ordered first.

Definition at line 1419 of file basic_string.tcc.

References std::basic_string< _CharT, _Traits, _Alloc >::data(), and std::min().

◆ copy()

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::copy ( _CharT *  __s,
size_type  __n,
size_type  __pos = 0 
) const

Copy substring into C string.

Parameters
__sC string to copy value into.
__nNumber of characters to copy.
__posIndex of first character to copy.
Returns
Number of characters actually copied
Exceptions
std::out_of_rangeIf __pos > size().

Copies up to __n characters starting at __pos into the C string __s. If __pos is greater than size(), out_of_range is thrown.

Definition at line 1154 of file basic_string.tcc.

◆ crbegin()

template<typename _CharT , typename _Traits , typename _Alloc >
const_reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::crbegin ( ) const
inlinenoexcept

Returns a read-only (constant) reverse iterator that points to the last character in the string. Iteration is done in reverse element order.

Definition at line 3943 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::end().

◆ crend()

template<typename _CharT , typename _Traits , typename _Alloc >
const_reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::crend ( ) const
inlinenoexcept

Returns a read-only (constant) reverse iterator that points to one before the first character in the string. Iteration is done in reverse element order.

Definition at line 3952 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::begin().

◆ data() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const _CharT* std::basic_string< _CharT, _Traits, _Alloc >::data ( ) const
inlinenoexcept

◆ data() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
_CharT* std::basic_string< _CharT, _Traits, _Alloc >::data ( )
inlinenoexcept

Return non-const pointer to contents.

This is a pointer to the character sequence held by the string. Modifying the characters in the sequence is allowed.

Definition at line 5277 of file basic_string.h.

◆ empty()

template<typename _CharT , typename _Traits , typename _Alloc >
bool std::basic_string< _CharT, _Traits, _Alloc >::empty ( ) const
inlinenoexcept

Returns true if the string is empty. Equivalent to *this == "".

Definition at line 4074 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ end() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
iterator std::basic_string< _CharT, _Traits, _Alloc >::end ( )
inline

Returns a read/write iterator that points one past the last character in the string. Unshares the string.

Definition at line 3870 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::size().

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::crbegin(), std::basic_string< _CharT, _Traits, _Alloc >::rbegin(), std::regex_match(), std::regex_replace(), and std::regex_search().

◆ end() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const_iterator std::basic_string< _CharT, _Traits, _Alloc >::end ( ) const
inlinenoexcept

Returns a read-only (constant) iterator that points one past the last character in the string.

Definition at line 3881 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ erase() [1/3]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::iterator std::basic_string< _CharT, _Traits, _Alloc >::erase ( iterator  __first,
iterator  __last 
)

Remove a range of characters.

Parameters
__firstIterator referencing the first character to remove.
__lastIterator referencing the end of the range.
Returns
Iterator referencing location of first after removal.

Removes the characters in the range [first,last) from this string. The value of the string doesn't change if an error is thrown.

Definition at line 821 of file basic_string.tcc.

◆ erase() [2/3]

template<typename _CharT , typename _Traits , typename _Alloc >
iterator std::basic_string< _CharT, _Traits, _Alloc >::erase ( iterator  __position)
inline

Remove one character.

Parameters
__positionIterator referencing the character to remove.
Returns
iterator referencing same location after removal.

Removes the character at __position from this string. The value of the string doesn't change if an error is thrown.

Definition at line 4773 of file basic_string.h.

◆ erase() [3/3]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::erase ( size_type  __pos = 0,
size_type  __n = npos 
)
inline

Remove characters.

Parameters
__posIndex of first character to remove (default 0).
__nNumber of characters to remove (default remainder).
Returns
Reference to this string.
Exceptions
std::out_of_rangeIf pos is beyond the end of this string.

Removes __n characters from this string starting at __pos. The length of the string is reduced by __n. If there are < __n characters to remove, the remainder of the string is truncated. If __p is beyond end of string, out_of_range is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4757 of file basic_string.h.

◆ find() [1/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::find ( _CharT  __c,
size_type  __pos = 0 
) const
noexcept

Find position of a character.

Parameters
__cCharacter to locate.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Starting from __pos, searches forward for __c within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 1243 of file basic_string.tcc.

References std::size().

◆ find() [2/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::find ( const _CharT *  __s,
size_type  __pos,
size_type  __n 
) const
noexcept

Find position of a C substring.

Parameters
__sC string to locate.
__posIndex of character to search from.
__nNumber of characters from s to search for.
Returns
Index of start of first occurrence.

Starting from __pos, searches forward for the first __n characters in __s within this string. If found, returns the index where it begins. If not found, returns npos.

Definition at line 1207 of file basic_string.tcc.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::find(), and std::basic_string< _CharT, _Traits, _Alloc >::find_first_of().

◆ find() [3/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find ( const _CharT *  __s,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a C string.

Parameters
__sC string to locate.
__posIndex of character to search from (default 0).
Returns
Index of start of first occurrence.

Starting from __pos, searches forward for the value of __s within this string. If found, returns the index where it begins. If not found, returns npos.

Definition at line 5333 of file basic_string.h.

◆ find() [4/5]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, size_type> std::basic_string< _CharT, _Traits, _Alloc >::find ( const _Tp &  __svt,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a string_view.

Parameters
__svtThe object convertible to string_view to locate.
__posIndex of character to search from (default 0).
Returns
Index of start of first occurrence.

Definition at line 5361 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::find().

◆ find() [5/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a string.

Parameters
__strString to locate.
__posIndex of character to search from (default 0).
Returns
Index of start of first occurrence.

Starting from __pos, searches forward for value of __str within this string. If found, returns the index where it begins. If not found, returns npos.

Definition at line 5318 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::find().

◆ find_first_not_of() [1/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of ( _CharT  __c,
size_type  __pos = 0 
) const
noexcept

Find position of a different character.

Parameters
__cCharacter to avoid.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Starting from __pos, searches forward for a character other than __c within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 1351 of file basic_string.tcc.

References std::size().

◆ find_first_not_of() [2/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of ( const _CharT *  __s,
size_type  __pos,
size_type  __n 
) const
noexcept

Find position of a character not in C substring.

Parameters
__sC string containing characters to avoid.
__posIndex of character to search from.
__nNumber of characters from __s to consider.
Returns
Index of first occurrence.

Starting from __pos, searches forward for a character not contained in the first __n characters of __s within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 1338 of file basic_string.tcc.

◆ find_first_not_of() [3/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of ( const _CharT *  __s,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a character not in C string.

Parameters
__sC string containing characters to avoid.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Starting from __pos, searches forward for a character not contained in __s within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 5657 of file basic_string.h.

◆ find_first_not_of() [4/5]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, size_type> std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of ( const _Tp &  __svt,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a character not in a string_view.

Parameters
__svtAn object convertible to string_view containing characters to avoid.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Definition at line 5688 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of().

◆ find_first_not_of() [5/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a character not in string.

Parameters
__strString containing characters to avoid.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Starting from __pos, searches forward for a character not contained in __str within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 5626 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of().

◆ find_first_of() [1/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_first_of ( _CharT  __c,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a character.

Parameters
__cCharacter to locate.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Starting from __pos, searches forward for the character __c within this string. If found, returns the index where it was found. If not found, returns npos.

Note: equivalent to find(__c, __pos).

Definition at line 5510 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::find().

◆ find_first_of() [2/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::find_first_of ( const _CharT *  __s,
size_type  __pos,
size_type  __n 
) const
noexcept

Find position of a character of C substring.

Parameters
__sString containing characters to locate.
__posIndex of character to search from.
__nNumber of characters from s to search for.
Returns
Index of first occurrence.

Starting from __pos, searches forward for one of the first __n characters of __s within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 1300 of file basic_string.tcc.

◆ find_first_of() [3/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_first_of ( const _CharT *  __s,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a character of C string.

Parameters
__sString containing characters to locate.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Starting from __pos, searches forward for one of the characters of __s within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 5490 of file basic_string.h.

◆ find_first_of() [4/5]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, size_type> std::basic_string< _CharT, _Traits, _Alloc >::find_first_of ( const _Tp &  __svt,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a character of a string_view.

Parameters
__svtAn object convertible to string_view containing characters to locate.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Definition at line 5523 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::find_first_of().

◆ find_first_of() [5/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_first_of ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos = 0 
) const
inlinenoexcept

Find position of a character of string.

Parameters
__strString containing characters to locate.
__posIndex of character to search from (default 0).
Returns
Index of first occurrence.

Starting from __pos, searches forward for one of the characters of __str within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 5459 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::find_first_of().

◆ find_last_not_of() [1/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of ( _CharT  __c,
size_type  __pos = npos 
) const
noexcept

Find last position of a different character.

Parameters
__cCharacter to avoid.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Starting from __pos, searches backward for a character other than __c within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 1384 of file basic_string.tcc.

References std::size().

◆ find_last_not_of() [2/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of ( const _CharT *  __s,
size_type  __pos,
size_type  __n 
) const
noexcept

Find last position of a character not in C substring.

Parameters
__sC string containing characters to avoid.
__posIndex of character to search back from.
__nNumber of characters from s to consider.
Returns
Index of last occurrence.

Starting from __pos, searches backward for a character not contained in the first __n characters of __s within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 1362 of file basic_string.tcc.

◆ find_last_not_of() [3/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of ( const _CharT *  __s,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a character not in C string.

Parameters
__sC string containing characters to avoid.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Starting from __pos, searches backward for a character not contained in __s within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 5739 of file basic_string.h.

◆ find_last_not_of() [4/5]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, size_type> std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of ( const _Tp &  __svt,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a character not in a string_view.

Parameters
__svtAn object convertible to string_view containing characters to avoid.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Definition at line 5770 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of().

◆ find_last_not_of() [5/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a character not in string.

Parameters
__strString containing characters to avoid.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Starting from __pos, searches backward for a character not contained in __str within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 5708 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of().

◆ find_last_of() [1/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_last_of ( _CharT  __c,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a character.

Parameters
__cCharacter to locate.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Starting from __pos, searches backward for __c within this string. If found, returns the index where it was found. If not found, returns npos.

Note: equivalent to rfind(__c, __pos).

Definition at line 5594 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::rfind().

◆ find_last_of() [2/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::find_last_of ( const _CharT *  __s,
size_type  __pos,
size_type  __n 
) const
noexcept

Find last position of a character of C substring.

Parameters
__sC string containing characters to locate.
__posIndex of character to search back from.
__nNumber of characters from s to search for.
Returns
Index of last occurrence.

Starting from __pos, searches backward for one of the first __n characters of __s within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 1316 of file basic_string.tcc.

◆ find_last_of() [3/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_last_of ( const _CharT *  __s,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a character of C string.

Parameters
__sC string containing characters to locate.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Starting from __pos, searches backward for one of the characters of __s within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 5574 of file basic_string.h.

◆ find_last_of() [4/5]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, size_type> std::basic_string< _CharT, _Traits, _Alloc >::find_last_of ( const _Tp &  __svt,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a character of string.

Parameters
__svtAn object convertible to string_view containing characters to locate.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Definition at line 5607 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::find_last_of().

◆ find_last_of() [5/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::find_last_of ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a character of string.

Parameters
__strString containing characters to locate.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Starting from __pos, searches backward for one of the characters of __str within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 5543 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::find_last_of().

◆ front() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
reference std::basic_string< _CharT, _Traits, _Alloc >::front ( )
inline

Returns a read/write reference to the data at the first element of the string.

Definition at line 4167 of file basic_string.h.

◆ front() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const_reference std::basic_string< _CharT, _Traits, _Alloc >::front ( ) const
inlinenoexcept

Returns a read-only (constant) reference to the data at the first element of the string.

Definition at line 4178 of file basic_string.h.

◆ get_allocator()

◆ insert() [1/11]

template<typename _CharT , typename _Traits , typename _Alloc >
iterator std::basic_string< _CharT, _Traits, _Alloc >::insert ( iterator  __p,
_CharT  __c 
)
inline

Insert one character.

Parameters
__pIterator referencing position in string to insert at.
__cThe character to insert.
Returns
Iterator referencing newly inserted char.
Exceptions
std::length_errorIf new length exceeds max_size().

Inserts character __c at position referenced by __p. If adding character causes the length to exceed max_size(), length_error is thrown. If __p is beyond end of string, out_of_range is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4697 of file basic_string.h.

◆ insert() [2/11]

template<typename _CharT , typename _Traits , typename _Alloc >
template<class _InputIterator >
void std::basic_string< _CharT, _Traits, _Alloc >::insert ( iterator  __p,
_InputIterator  __beg,
_InputIterator  __end 
)
inline

Insert a range of characters.

Parameters
__pIterator referencing location in string to insert at.
__begStart of range.
__endEnd of range.
Exceptions
std::length_errorIf new length exceeds max_size().

Inserts characters in range [__beg,__end). If adding characters causes the length to exceed max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4562 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ insert() [3/11]

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::insert ( iterator  __p,
initializer_list< _CharT >  __l 
)
inline

Insert an initializer_list of characters.

Parameters
__pIterator referencing location in string to insert at.
__lThe initializer_list of characters to insert.
Exceptions
std::length_errorIf new length exceeds max_size().

Definition at line 4573 of file basic_string.h.

◆ insert() [4/11]

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::insert ( iterator  __p,
size_type  __n,
_CharT  __c 
)
inline

Insert multiple characters.

Parameters
__pIterator referencing location in string to insert at.
__nNumber of characters to insert
__cThe character to insert.
Exceptions
std::length_errorIf new length exceeds max_size().

Inserts __n copies of character __c starting at the position referenced by iterator __p. If adding characters causes the length to exceed max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4545 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::insert().

◆ insert() [5/11]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::insert ( size_type  __pos,
const _CharT *  __s 
)
inline

Insert a C string.

Parameters
__posPosition in string to insert at.
__sThe C string to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().
std::out_of_rangeIf pos is beyond the end of this string.

Inserts the first n characters of __s starting at __pos. If adding characters causes the length to exceed max_size(), length_error is thrown. If __pos is beyond end(), out_of_range is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4656 of file basic_string.h.

◆ insert() [6/11]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc > & std::basic_string< _CharT, _Traits, _Alloc >::insert ( size_type  __pos,
const _CharT *  __s,
size_type  __n 
)

Insert a C substring.

Parameters
__posPosition in string to insert at.
__sThe C string to insert.
__nThe number of characters to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().
std::out_of_rangeIf __pos is beyond the end of this string.

Inserts the first __n characters of __s starting at __pos. If adding characters causes the length to exceed max_size(), length_error is thrown. If __pos is beyond end(), out_of_range is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 790 of file basic_string.tcc.

◆ insert() [7/11]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::insert ( size_type  __pos,
const _Tp &  __svt 
)
inline

Insert a string_view.

Parameters
__posPosition in string to insert at.
__svtThe object convertible to string_view to insert.
Returns
Reference to this string.

Definition at line 4715 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::insert().

◆ insert() [8/11]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::insert ( size_type  __pos,
size_type  __n,
_CharT  __c 
)
inline

Insert multiple characters.

Parameters
__posIndex in string to insert at.
__nNumber of characters to insert
__cThe character to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().
std::out_of_rangeIf __pos is beyond the end of this string.

Inserts __n copies of character __c starting at index __pos. If adding characters causes the length to exceed max_size(), length_error is thrown. If __pos > length(), out_of_range is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4679 of file basic_string.h.

◆ insert() [9/11]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::insert ( size_type  __pos1,
const _Tp &  __svt,
size_type  __pos2,
size_type  __n = npos 
)
inline

Insert a string_view.

Parameters
__pos1Position in string to insert at.
__svtThe object convertible to string_view to insert from.
__pos2Position in string_view to insert from.
__nThe number of characters to insert.
Returns
Reference to this string.

Definition at line 4731 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ insert() [10/11]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::insert ( size_type  __pos1,
const basic_string< _CharT, _Traits, _Alloc > &  __str 
)
inline

Insert value of a string.

Parameters
__pos1Position in string to insert at.
__strThe string to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().

Inserts value of __str starting at __pos1. If adding characters causes the length to exceed max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4593 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::insert().

◆ insert() [11/11]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::insert ( size_type  __pos1,
const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos2,
size_type  __n = npos 
)
inline

Insert a substring.

Parameters
__pos1Position in string to insert at.
__strThe string to insert.
__pos2Start of characters in str to insert.
__nNumber of characters to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().
std::out_of_rangeIf pos1 > size() or __pos2 > str.size().

Starting at pos1, insert __n character of __str beginning with __pos2. If adding characters causes the length to exceed max_size(), length_error is thrown. If __pos1 is beyond the end of this string or __pos2 is beyond the end of __str, out_of_range is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4615 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::insert().

◆ length()

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::length ( ) const
inlinenoexcept

Returns the number of characters in the string, not including any null-termination.

Definition at line 3967 of file basic_string.h.

Referenced by std::collate< _CharT >::do_compare(), and std::collate< _CharT >::do_transform().

◆ max_size()

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::max_size ( ) const
inlinenoexcept

Returns the size() of the largest possible string.

Definition at line 3972 of file basic_string.h.

Referenced by std::getline().

◆ operator __sv_type()

template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::operator __sv_type ( ) const
inlinenoexcept

Convert to a string_view.

Returns
A string_view.

Definition at line 3841 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::data(), and std::basic_string< _CharT, _Traits, _Alloc >::size().

◆ operator+=() [1/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator+= ( _CharT  __c)
inline

Append a character.

Parameters
__cThe character to append.
Returns
Reference to this string.

Definition at line 4232 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::push_back().

◆ operator+=() [2/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator+= ( const _CharT *  __s)
inline

Append a C string.

Parameters
__sThe C string to append.
Returns
Reference to this string.

Definition at line 4223 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::append().

◆ operator+=() [3/5]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::operator+= ( const _Tp &  __svt)
inline

Append a string_view.

Parameters
__svtThe object convertible to string_view to be appended.
Returns
Reference to this string.

Definition at line 4257 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::append().

◆ operator+=() [4/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator+= ( const basic_string< _CharT, _Traits, _Alloc > &  __str)
inline

Append a string to this string.

Parameters
__strThe string to append.
Returns
Reference to this string.

Definition at line 4214 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::append().

◆ operator+=() [5/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator+= ( initializer_list< _CharT >  __l)
inline

Append an initializer_list of characters.

Parameters
__lThe initializer_list of characters to be appended.
Returns
Reference to this string.

Definition at line 4245 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::append().

◆ operator=() [1/6]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator= ( _CharT  __c)
inline

Set value to string of length 1.

Parameters
__cSource character.

Assigning to a character makes this string length 1 and (*this)[0] == c.

Definition at line 3792 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ operator=() [2/6]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator= ( basic_string< _CharT, _Traits, _Alloc > &&  __str)
inlinenoexcept

Move assign the value of str to this string.

Parameters
__strSource string.

The contents of str are moved into this string (without copying). str is a valid, but unspecified string.

Definition at line 3807 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::swap().

◆ operator=() [3/6]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator= ( const _CharT *  __s)
inline

Copy contents of s into this string.

Parameters
__sSource null-terminated string.

Definition at line 3781 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ operator=() [4/6]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::operator= ( const _Tp &  __svt)
inline

Set value to string constructed from a string_view.

Parameters
__svtAn object convertible to string_view.

Definition at line 3834 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ operator=() [5/6]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator= ( const basic_string< _CharT, _Traits, _Alloc > &  __str)
inline

Assign the value of str to this string.

Parameters
__strSource string.

Definition at line 3773 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ operator=() [6/6]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::operator= ( initializer_list< _CharT >  __l)
inline

Set value to string constructed from initializer list.

Parameters
__lstd::initializer_list.

Definition at line 3820 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::assign().

◆ operator[]() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
reference std::basic_string< _CharT, _Traits, _Alloc >::operator[] ( size_type  __pos)
inline

Subscript access to the data contained in the string.

Parameters
__posThe index of the character to access.
Returns
Read/write reference to the character.

This operator allows for easy, array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined. (For checked lookups see at().) Unshares the string.

Definition at line 4106 of file basic_string.h.

◆ operator[]() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const_reference std::basic_string< _CharT, _Traits, _Alloc >::operator[] ( size_type  __pos) const
inlinenoexcept

Subscript access to the data contained in the string.

Parameters
__posThe index of the character to access.
Returns
Read-only (constant) reference to the character.

This operator allows for easy, array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined. (For checked lookups see at().)

Definition at line 4089 of file basic_string.h.

◆ pop_back()

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::pop_back ( )
inline

Remove the last character.

The string must be non-empty.

Definition at line 4802 of file basic_string.h.

◆ push_back()

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::push_back ( _CharT  __c)
inline

◆ rbegin() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::rbegin ( )
inline

Returns a read/write reverse iterator that points to the last character in the string. Iteration is done in reverse element order. Unshares the string.

Definition at line 3890 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::end().

◆ rbegin() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const_reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::rbegin ( ) const
inlinenoexcept

Returns a read-only (constant) reverse iterator that points to the last character in the string. Iteration is done in reverse element order.

Definition at line 3899 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::end().

◆ rend() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::rend ( )
inline

Returns a read/write reverse iterator that points to one before the first character in the string. Iteration is done in reverse element order. Unshares the string.

Definition at line 3908 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::begin().

◆ rend() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
const_reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::rend ( ) const
inlinenoexcept

Returns a read-only (constant) reverse iterator that points to one before the first character in the string. Iteration is done in reverse element order.

Definition at line 3917 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::begin().

◆ replace() [1/14]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::replace ( const_iterator  __i1,
const_iterator  __i2,
const _Tp &  __svt 
)
inline

Replace range of characters with string_view.

Parameters
__i1An iterator referencing the start position to replace at.
__i2An iterator referencing the end position for the replace.
__svtThe object convertible to string_view to insert from.
Returns
Reference to this string.

Definition at line 5143 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::begin(), and std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ replace() [2/14]

template<typename _CharT , typename _Traits , typename _Alloc >
template<class _InputIterator >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( iterator  __i1,
iterator  __i2,
_InputIterator  __k1,
_InputIterator  __k2 
)
inline

Replace range of characters with range.

Parameters
__i1Iterator referencing start of range to replace.
__i2Iterator referencing end of range to replace.
__k1Iterator referencing start of range to insert.
__k2Iterator referencing end of range to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__i1,__i2). In place, characters in the range [__k1,__k2) are inserted. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 5021 of file basic_string.h.

◆ replace() [3/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( iterator  __i1,
iterator  __i2,
const _CharT *  __s 
)
inline

Replace range of characters with C string.

Parameters
__i1Iterator referencing start of range to replace.
__i2Iterator referencing end of range to replace.
__sC string value to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__i1,__i2). In place, the characters of __s are inserted. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4976 of file basic_string.h.

◆ replace() [4/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( iterator  __i1,
iterator  __i2,
const _CharT *  __s,
size_type  __n 
)
inline

Replace range of characters with C substring.

Parameters
__i1Iterator referencing start of range to replace.
__i2Iterator referencing end of range to replace.
__sC string value to insert.
__nNumber of characters from s to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__i1,__i2). In place, the first __n characters of __s are inserted. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4955 of file basic_string.h.

◆ replace() [5/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( iterator  __i1,
iterator  __i2,
const basic_string< _CharT, _Traits, _Alloc > &  __str 
)
inline

Replace range of characters with string.

Parameters
__i1Iterator referencing start of range to replace.
__i2Iterator referencing end of range to replace.
__strString value to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__i1,__i2). In place, the value of __str is inserted. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4936 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ replace() [6/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( iterator  __i1,
iterator  __i2,
initializer_list< _CharT >  __l 
)
inline

Replace range of characters with initializer_list.

Parameters
__i1Iterator referencing start of range to replace.
__i2Iterator referencing end of range to replace.
__lThe initializer_list of characters to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__i1,__i2). In place, characters in the range [__k1,__k2) are inserted. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 5090 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ replace() [7/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( iterator  __i1,
iterator  __i2,
size_type  __n,
_CharT  __c 
)
inline

Replace range of characters with multiple characters.

Parameters
__i1Iterator referencing start of range to replace.
__i2Iterator referencing end of range to replace.
__nNumber of characters to insert.
__cCharacter to insert.
Returns
Reference to this string.
Exceptions
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__i1,__i2). In place, __n copies of __c are inserted. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4997 of file basic_string.h.

◆ replace() [8/14]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::replace ( size_type  __pos,
size_type  __n,
const _Tp &  __svt 
)
inline

Replace range of characters with string_view.

Parameters
__posThe position to replace at.
__nThe number of characters to replace.
__svtThe object convertible to string_view to insert.
Returns
Reference to this string.

Definition at line 5105 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ replace() [9/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( size_type  __pos,
size_type  __n,
const basic_string< _CharT, _Traits, _Alloc > &  __str 
)
inline

Replace characters with value from another string.

Parameters
__posIndex of first character to replace.
__nNumber of characters to be replaced.
__strString to insert.
Returns
Reference to this string.
Exceptions
std::out_of_rangeIf pos is beyond the end of this string.
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__pos,__pos+__n) from this string. In place, the value of __str is inserted. If __pos is beyond end of string, out_of_range is thrown. If the length of the result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4827 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::append(), std::basic_string< _CharT, _Traits, _Alloc >::assign(), std::basic_string< _CharT, _Traits, _Alloc >::insert(), and std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ replace() [10/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( size_type  __pos,
size_type  __n1,
const _CharT *  __s 
)
inline

Replace characters with value of a C string.

Parameters
__posIndex of first character to replace.
__n1Number of characters to be replaced.
__sC string to insert.
Returns
Reference to this string.
Exceptions
std::out_of_rangeIf pos > size().
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__pos,__pos + __n1) from this string. In place, the characters of __s are inserted. If __pos is beyond end of string, out_of_range is thrown. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4894 of file basic_string.h.

◆ replace() [11/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc > & std::basic_string< _CharT, _Traits, _Alloc >::replace ( size_type  __pos,
size_type  __n1,
const _CharT *  __s,
size_type  __n2 
)

Replace characters with value of a C substring.

Parameters
__posIndex of first character to replace.
__n1Number of characters to be replaced.
__sC string to insert.
__n2Number of characters from s to use.
Returns
Reference to this string.
Exceptions
std::out_of_rangeIf pos1 > size().
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__pos,__pos + __n1) from this string. In place, the first __n2 characters of __s are inserted, or all of __s if __n2 is too large. If __pos is beyond end of string, out_of_range is thrown. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 844 of file basic_string.tcc.

◆ replace() [12/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( size_type  __pos,
size_type  __n1,
size_type  __n2,
_CharT  __c 
)
inline

Replace characters with multiple characters.

Parameters
__posIndex of first character to replace.
__n1Number of characters to be replaced.
__n2Number of characters to insert.
__cCharacter to insert.
Returns
Reference to this string.
Exceptions
std::out_of_rangeIf __pos > size().
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [pos,pos + n1) from this string. In place, __n2 copies of __c are inserted. If __pos is beyond end of string, out_of_range is thrown. If the length of result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4918 of file basic_string.h.

◆ replace() [13/14]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, basic_string&> std::basic_string< _CharT, _Traits, _Alloc >::replace ( size_type  __pos1,
size_type  __n1,
const _Tp &  __svt,
size_type  __pos2,
size_type  __n2 = npos 
)
inline

Replace range of characters with string_view.

Parameters
__pos1The position to replace at.
__n1The number of characters to replace.
__svtThe object convertible to string_view to insert from.
__pos2The position in the string_view to insert from.
__n2The number of characters to insert.
Returns
Reference to this string.

Definition at line 5122 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ replace() [14/14]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string& std::basic_string< _CharT, _Traits, _Alloc >::replace ( size_type  __pos1,
size_type  __n1,
const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos2,
size_type  __n2 = npos 
)
inline

Replace characters with value from another string.

Parameters
__pos1Index of first character to replace.
__n1Number of characters to be replaced.
__strString to insert.
__pos2Index of first character of str to use.
__n2Number of characters from str to use.
Returns
Reference to this string.
Exceptions
std::out_of_rangeIf __pos1 > size() or __pos2 > __str.size().
std::length_errorIf new length exceeds max_size().

Removes the characters in the range [__pos1,__pos1 + n) from this string. In place, the value of __str is inserted. If __pos is beyond end of string, out_of_range is thrown. If the length of the result exceeds max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.

Definition at line 4849 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::replace().

◆ reserve() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::reserve

◆ reserve() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::reserve ( size_type  __res_arg)

Attempt to preallocate enough memory for specified number of characters.

Parameters
__res_argNumber of characters required.
Exceptions
std::length_errorIf __res_arg exceeds max_size().

This function attempts to reserve enough memory for the string to hold the specified number of characters. If the number requested is more than max_size(), length_error is thrown.

The advantage of this function is that if optimal code is a necessity and the user can determine the string length that will be required, the user can reserve the memory in advance, and thus prevent a possible reallocation of memory and copying of string data.

Definition at line 932 of file basic_string.tcc.

References std::size().

Referenced by std::num_get< _CharT, _InIter >::do_get(), std::operator<<(), std::tr2::operator>>(), and std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow().

◆ resize() [1/2]

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::resize ( size_type  __n)
inline

Resizes the string to the specified number of characters.

Parameters
__nNumber of characters the string should contain.

This function will resize the string to the specified length. If the new size is smaller than the string's current size the string is truncated, otherwise the string is extended and new characters are default-constructed. For basic types such as char, this means setting them to 0.

Definition at line 3999 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::resize().

◆ resize() [2/2]

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::resize ( size_type  __n,
_CharT  __c 
)

Resizes the string to the specified number of characters.

Parameters
__nNumber of characters the string should contain.
__cCharacter to fill any new elements.

This function will resize the string to the specified number of characters. If the number is smaller than the string's current size the string is truncated, otherwise the string is extended and new elements are set to __c.

Definition at line 1080 of file basic_string.tcc.

References std::size().

Referenced by std::money_get< _CharT, _InIter >::do_get(), and std::basic_string< _CharT, _Traits, _Alloc >::resize().

◆ rfind() [1/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::rfind ( _CharT  __c,
size_type  __pos = npos 
) const
noexcept

Find last position of a character.

Parameters
__cCharacter to locate.
__posIndex of character to search back from (default end).
Returns
Index of last occurrence.

Starting from __pos, searches backward for __c within this string. If found, returns the index where it was found. If not found, returns npos.

Definition at line 1283 of file basic_string.tcc.

References std::size().

◆ rfind() [2/5]

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::rfind ( const _CharT *  __s,
size_type  __pos,
size_type  __n 
) const
noexcept

Find last position of a C substring.

Parameters
__sC string to locate.
__posIndex of character to search back from.
__nNumber of characters from s to search for.
Returns
Index of start of last occurrence.

Starting from __pos, searches backward for the first __n characters in __s within this string. If found, returns the index where it begins. If not found, returns npos.

Definition at line 1261 of file basic_string.tcc.

◆ rfind() [3/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::rfind ( const _CharT *  __s,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a C string.

Parameters
__sC string to locate.
__posIndex of character to start search at (default end).
Returns
Index of start of last occurrence.

Starting from __pos, searches backward for the value of __s within this string. If found, returns the index where it begins. If not found, returns npos.

Definition at line 5411 of file basic_string.h.

◆ rfind() [4/5]

template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp >
_If_sv<_Tp, size_type> std::basic_string< _CharT, _Traits, _Alloc >::rfind ( const _Tp &  __svt,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a string_view.

Parameters
__svtThe object convertible to string_view to locate.
__posIndex of character to search back from (default end).
Returns
Index of start of last occurrence.

Definition at line 5439 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::rfind().

◆ rfind() [5/5]

template<typename _CharT , typename _Traits , typename _Alloc >
size_type std::basic_string< _CharT, _Traits, _Alloc >::rfind ( const basic_string< _CharT, _Traits, _Alloc > &  __str,
size_type  __pos = npos 
) const
inlinenoexcept

Find last position of a string.

Parameters
__strString to locate.
__posIndex of character to search back from (default end).
Returns
Index of start of last occurrence.

Starting from __pos, searches backward for value of __str within this string. If found, returns the index where it begins. If not found, returns npos.

Definition at line 5380 of file basic_string.h.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::find_last_of(), and std::basic_string< _CharT, _Traits, _Alloc >::rfind().

◆ shrink_to_fit()

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::shrink_to_fit ( )
inlinenoexcept

A non-binding request to reduce capacity() to size().

Definition at line 4007 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::reserve().

◆ size()

◆ substr()

template<typename _CharT , typename _Traits , typename _Alloc >
basic_string std::basic_string< _CharT, _Traits, _Alloc >::substr ( size_type  __pos = 0,
size_type  __n = npos 
) const
inline

Get a substring.

Parameters
__posIndex of first character (default 0).
__nNumber of characters in substring (default remainder).
Returns
The new string.
Exceptions
std::out_of_rangeIf __pos > size().

Construct and return a new string using the __n characters starting at __pos. If the string is too short, use the remainder of the characters. If __pos is beyond the end of the string, out_of_range is thrown.

Definition at line 5791 of file basic_string.h.

References std::basic_string< _CharT, _Traits, _Alloc >::basic_string().

◆ swap()

template<typename _CharT , typename _Traits , typename _Alloc >
void std::basic_string< _CharT, _Traits, _Alloc >::swap ( basic_string< _CharT, _Traits, _Alloc > &  __s)
noexcept

Swap contents with another string.

Parameters
__sString to swap with.

Exchanges the contents of this string with that of __s in constant time.

Definition at line 958 of file basic_string.tcc.

Referenced by std::basic_string< _CharT, _Traits, _Alloc >::assign(), and std::basic_string< _CharT, _Traits, _Alloc >::operator=().

Member Data Documentation

◆ npos

template<typename _CharT , typename _Traits , typename _Alloc >
const basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string< _CharT, _Traits, _Alloc >::npos
static

Value returned by various member functions when they fail.

Definition at line 3387 of file basic_string.h.


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