Public Types¶

typedef _Alloc allocator_type
typedef __gnu_cxx::__normal_iterator< const_pointer, basic_string > const_iterator
typedef _CharT_alloc_type::const_pointer const_pointer
typedef _CharT_alloc_type::const_reference const_reference
typedef std::reverse_iterator< const_iterator > const_reverse_iterator
typedef _CharT_alloc_type::difference_type difference_type
typedef __gnu_cxx::__normal_iterator< pointer, basic_string > iterator
typedef _CharT_alloc_type::pointer pointer
typedef _CharT_alloc_type::reference reference
typedef std::reverse_iterator< iterator > reverse_iterator
typedef _CharT_alloc_type::size_type size_type
typedef _Traits traits_type
typedef _Traits::char_type value_type

Public Member Functions¶

basic_string ()
Default constructor creates an empty string. basic_string (const _Alloc &__a)
Construct an empty string using allocator a. basic_string (const basic_string &__str)
Construct string with copy of value of str. basic_string (const basic_string &__str, size_type __pos, size_type __n=npos)
Construct string as copy of a substring. basic_string (const basic_string &__str, size_type __pos, size_type __n, const _Alloc &__a)
Construct string as copy of a substring. basic_string (const _CharT *__s, size_type __n, const _Alloc &__a=_Alloc())
Construct string initialized by a character array. basic_string (const _CharT *__s, const _Alloc &__a=_Alloc())
Construct string as copy of a C string. basic_string (size_type __n, _CharT __c, const _Alloc &__a=_Alloc())
Construct string as multiple characters. basic_string (basic_string &&__str) noexcept
Move construct string. basic_string (initializer_list< _CharT > __l, const _Alloc &__a=_Alloc())
Construct string from an initializer list. template<class _InputIterator > basic_string (_InputIterator __beg, _InputIterator __end, const _Alloc &__a=_Alloc())
Construct string as copy of a range. ~basic_string () noexcept
Destroy the string instance. 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)
basic_string & append (const basic_string &__str)
Append a string to this string. basic_string & append (const basic_string &__str, size_type __pos, size_type __n)
Append a substring. basic_string & append (const _CharT *__s, size_type __n)
Append a C substring. basic_string & append (const _CharT *__s)
Append a C string. basic_string & append (size_type __n, _CharT __c)
Append multiple characters. basic_string & append (initializer_list< _CharT > __l)
Append an initializer_list of characters. template<class _InputIterator > basic_string & append (_InputIterator __first, _InputIterator __last)
Append a range of characters. basic_string & assign (const basic_string &__str)
Set value to contents of another string. basic_string & assign (basic_string &&__str)
Set value to contents of another string. basic_string & assign (const basic_string &__str, size_type __pos, size_type __n)
Set value to a substring of a string. basic_string & assign (const _CharT *__s, size_type __n)
Set value to a C substring. basic_string & assign (const _CharT *__s)
Set value to contents of a C string. basic_string & assign (size_type __n, _CharT __c)
Set value to multiple characters. template<class _InputIterator > basic_string & assign (_InputIterator __first, _InputIterator __last)
Set value to a range of characters. basic_string & assign (initializer_list< _CharT > __l)
Set value to an initializer_list of characters. const_reference at (size_type __n) const
Provides access to the data contained in the string. reference at (size_type __n)
Provides access to the data contained in the string. reference back ()
const_reference back () const noexcept
iterator begin ()
const_iterator begin () const noexcept
const _CharT * c_str () const noexcept
Return const pointer to null-terminated contents. size_type capacity () const noexcept
const_iterator cbegin () const noexcept
const_iterator cend () const noexcept
void clear ()
int compare (const basic_string &__str) const
Compare to a string. int compare (size_type __pos, size_type __n, const basic_string &__str) const
Compare substring to a string. int compare (size_type __pos1, size_type __n1, const basic_string &__str, size_type __pos2, size_type __n2) const
Compare substring to a substring. int compare (const _CharT *__s) const
Compare to a C string. int compare (size_type __pos, size_type __n1, const _CharT *__s) const
Compare substring to a C string. int compare (size_type __pos, size_type __n1, const _CharT *__s, size_type __n2) const
Compare substring against a character array. size_type copy (_CharT *__s, size_type __n, size_type __pos=0) const
Copy substring into C string. const_reverse_iterator crbegin () const noexcept
const_reverse_iterator crend () const noexcept
const _CharT * data () const noexcept
Return const pointer to contents. bool empty () const noexcept
iterator end ()
const_iterator end () const noexcept
basic_string & erase (size_type __pos=0, size_type __n=npos)
Remove characters. iterator erase (iterator __position)
Remove one character. iterator erase (iterator __first, iterator __last)
Remove a range of characters. size_type find (const _CharT *__s, size_type __pos, size_type __n) const
Find position of a C substring. size_type find (const basic_string &__str, size_type __pos=0) const noexcept
Find position of a string. size_type find (const _CharT *__s, size_type __pos=0) const
Find position of a C string. size_type find (_CharT __c, size_type __pos=0) const noexcept
Find position of a character. size_type find_first_not_of (const basic_string &__str, size_type __pos=0) const noexcept
Find position of a character not in string. size_type find_first_not_of (const _CharT *__s, size_type __pos, size_type __n) const
Find position of a character not in C substring. size_type find_first_not_of (const _CharT *__s, size_type __pos=0) const
Find position of a character not in C string. size_type find_first_not_of (_CharT __c, size_type __pos=0) const noexcept
Find position of a different character. size_type find_first_of (const basic_string &__str, size_type __pos=0) const noexcept
Find position of a character of string. size_type find_first_of (const _CharT *__s, size_type __pos, size_type __n) const
Find position of a character of C substring. size_type find_first_of (const _CharT *__s, size_type __pos=0) const
Find position of a character of C string. size_type find_first_of (_CharT __c, size_type __pos=0) const noexcept
Find position of a character. size_type find_last_not_of (const basic_string &__str, size_type __pos=npos) const noexcept
Find last position of a character not in string. size_type find_last_not_of (const _CharT *__s, size_type __pos, size_type __n) const
Find last position of a character not in C substring. size_type find_last_not_of (const _CharT *__s, size_type __pos=npos) const
Find last position of a character not in C string. size_type find_last_not_of (_CharT __c, size_type __pos=npos) const noexcept
Find last position of a different character. size_type find_last_of (const basic_string &__str, size_type __pos=npos) const noexcept
Find last position of a character of string. size_type find_last_of (const _CharT *__s, size_type __pos, size_type __n) const
Find last position of a character of C substring. size_type find_last_of (const _CharT *__s, size_type __pos=npos) const
Find last position of a character of C string. size_type find_last_of (_CharT __c, size_type __pos=npos) const noexcept
Find last position of a character. reference front ()
const_reference front () const noexcept
allocator_type get_allocator () const noexcept
Return copy of allocator used to construct this string. void insert (iterator __p, size_type __n, _CharT __c)
Insert multiple characters. template<class _InputIterator > void insert (iterator __p, _InputIterator __beg, _InputIterator __end)
Insert a range of characters. void insert (iterator __p, initializer_list< _CharT > __l)
Insert an initializer_list of characters. basic_string & insert (size_type __pos1, const basic_string &__str)
Insert value of a string. basic_string & insert (size_type __pos1, const basic_string &__str, size_type __pos2, size_type __n)
Insert a substring. basic_string & insert (size_type __pos, const _CharT *__s, size_type __n)
Insert a C substring. basic_string & insert (size_type __pos, const _CharT *__s)
Insert a C string. basic_string & insert (size_type __pos, size_type __n, _CharT __c)
Insert multiple characters. iterator insert (iterator __p, _CharT __c)
Insert one character. size_type length () const noexcept
Returns the number of characters in the string, not including any null-termination. size_type max_size () const noexcept
Returns the size() of the largest possible string. basic_string & operator+= (const basic_string &__str)
Append a string to this string. basic_string & operator+= (const _CharT *__s)
Append a C string. basic_string & operator+= (_CharT __c)
Append a character. basic_string & operator+= (initializer_list< _CharT > __l)
Append an initializer_list of characters. basic_string & operator= (const basic_string &__str)
Assign the value of str to this string. basic_string & operator= (const _CharT *__s)
Copy contents of s into this string. basic_string & operator= (_CharT __c)
Set value to string of length 1. basic_string & operator= (basic_string &&__str)
Move assign the value of str to this string. basic_string & operator= (initializer_list< _CharT > __l)
Set value to string constructed from initializer list. const_reference operator[] (size_type __pos) const noexcept
Subscript access to the data contained in the string. reference operator[] (size_type __pos)
Subscript access to the data contained in the string. void pop_back ()
Remove the last character. void push_back (_CharT __c)
Append a single character. reverse_iterator rbegin ()
const_reverse_iterator rbegin () const noexcept
reverse_iterator rend ()
const_reverse_iterator rend () const noexcept
basic_string & replace (size_type __pos, size_type __n, const basic_string &__str)
Replace characters with value from another string. basic_string & replace (size_type __pos1, size_type __n1, const basic_string &__str, size_type __pos2, size_type __n2)
Replace characters with value from another string. basic_string & replace (size_type __pos, size_type __n1, const _CharT *__s, size_type __n2)
Replace characters with value of a C substring. basic_string & replace (size_type __pos, size_type __n1, const _CharT *__s)
Replace characters with value of a C string. basic_string & replace (size_type __pos, size_type __n1, size_type __n2, _CharT __c)
Replace characters with multiple characters. basic_string & replace (iterator __i1, iterator __i2, const basic_string &__str)
Replace range of characters with string. basic_string & replace (iterator __i1, iterator __i2, const _CharT *__s, size_type __n)
Replace range of characters with C substring. basic_string & replace (iterator __i1, iterator __i2, const _CharT *__s)
Replace range of characters with C string. basic_string & replace (iterator __i1, iterator __i2, size_type __n, _CharT __c)
Replace range of characters with multiple characters. template<class _InputIterator > basic_string & replace (iterator __i1, iterator __i2, _InputIterator __k1, _InputIterator __k2)
Replace range of characters with range. basic_string & replace (iterator __i1, iterator __i2, _CharT *__k1, _CharT *__k2)
basic_string & replace (iterator __i1, iterator __i2, const _CharT *__k1, const _CharT *__k2)
basic_string & replace (iterator __i1, iterator __i2, iterator __k1, iterator __k2)
basic_string & replace (iterator __i1, iterator __i2, const_iterator __k1, const_iterator __k2)
basic_string & replace (iterator __i1, iterator __i2, initializer_list< _CharT > __l)
Replace range of characters with initializer_list. void reserve (size_type __res_arg=0)
Attempt to preallocate enough memory for specified number of characters. void resize (size_type __n, _CharT __c)
Resizes the string to the specified number of characters. void resize (size_type __n)
Resizes the string to the specified number of characters. size_type rfind (const basic_string &__str, size_type __pos=npos) const noexcept
Find last position of a string. size_type rfind (const _CharT *__s, size_type __pos, size_type __n) const
Find last position of a C substring. size_type rfind (const _CharT *__s, size_type __pos=npos) const
Find last position of a C string. size_type rfind (_CharT __c, size_type __pos=npos) const noexcept
Find last position of a character. void shrink_to_fit () noexcept
A non-binding request to reduce capacity() to size(). size_type size () const noexcept
Returns the number of characters in the string, not including any null-termination. basic_string substr (size_type __pos=0, size_type __n=npos) const
Get a substring. void swap (basic_string &__s)
Swap contents with another string.

Static Public Attributes¶

static const size_type npos
Value returned by various member functions when they fail.

template<typename _CharT, typename _Traits, typename _Alloc>¶

class std::basic_string< _CharT, _Traits, _Alloc >" Managing sequences of characters and character-like objects.

Template Parameters:

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

Documentation? What's that? Nathan Myers ncm@cantrip.org.

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 2614 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> std::basic_string< _CharT, _Traits, _Alloc >::basic_string () [inline]¶

Default constructor creates an empty string.

Definition at line 2972 of file basic_string.h.

Referenced by std::basic_string< char >::basic_string(), and std::basic_string< char >::substr().

template<typename _CharT , typename _Traits , typename _Alloc> std::basic_string< _CharT, _Traits, _Alloc >::basic_string (const _Alloc & __a) [explicit]¶

Construct an empty string using allocator a.

Definition at line 618 of file basic_string.tcc.

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

Construct string with copy of value of str.

Parameters:

Definition at line 610 of file basic_string.tcc.

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 = npos)¶

Construct string as copy of a substring.

Parameters:

Definition at line 624 of file basic_string.tcc.

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:

Definition at line 634 of file basic_string.tcc.

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())¶

Construct string initialized by a character array.

Parameters:

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

Definition at line 646 of file basic_string.tcc.

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

Construct string as copy of a C string.

Parameters:

Definition at line 653 of file basic_string.tcc.

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

Construct string as multiple characters.

Parameters:

Definition at line 660 of file basic_string.tcc.

template<typename _CharT, typename _Traits, typename _Alloc> std::basic_string< _CharT, _Traits, _Alloc >::basic_string (basic_string< _CharT, _Traits, _Alloc > && __str) [inline], [noexcept]¶

Move construct string.

Parameters:

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

Definition at line 3042 of file basic_string.h.

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

Construct string from an initializer list.

Parameters:

Definition at line 675 of file basic_string.tcc.

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

Construct string as copy of a range.

Parameters:

Definition at line 668 of file basic_string.tcc.

template<typename _CharT, typename _Traits, typename _Alloc> std::basic_string< _CharT, _Traits, _Alloc >::~basic_string () [inline], [noexcept]¶

Destroy the string instance.

Definition at line 3076 of file basic_string.h.

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:

Returns:

Definition at line 765 of file basic_string.tcc.

Referenced by std::basic_string< char >::append(), std::money_get< _CharT, _InIter >::do_get(), and std::basic_string< char >::operator+=().

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)¶

Append a substring.

Parameters:

Returns:

Exceptions:

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 782 of file basic_string.tcc.

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:

Returns:

Definition at line 738 of file basic_string.tcc.

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:

Returns:

Definition at line 3567 of file basic_string.h.

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:

Returns:

Appends __n copies of __c to this string.

Definition at line 721 of file basic_string.tcc.

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:

Returns:

Definition at line 3591 of file basic_string.h.

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:

Returns:

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

Definition at line 3605 of file basic_string.h.

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)¶

Set value to contents of another string.

Parameters:

Returns:

Definition at line 683 of file basic_string.tcc.

Referenced by std::basic_string< char >::assign(), std::money_get< _CharT, _InIter >::do_get(), std::basic_string< char >::operator=(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), and std::basic_string< char >::push_back().

template<typename _CharT, typename _Traits, typename _Alloc> basic_string& std::basic_string< _CharT, _Traits, _Alloc >::assign (basic_string< _CharT, _Traits, _Alloc > && __str) [inline]¶

Set value to contents of another string.

Parameters:

Returns:

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

Definition at line 3641 of file basic_string.h.

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) [inline]¶

Set value to a substring of a string.

Parameters:

Returns:

Exceptions:

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 3662 of file basic_string.h.

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:

Returns:

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 699 of file basic_string.tcc.

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:

Returns:

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 3690 of file basic_string.h.

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:

Returns:

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

Definition at line 3706 of file basic_string.h.

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:

Returns:

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

Definition at line 3719 of file basic_string.h.

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:

Returns:

Definition at line 3729 of file basic_string.h.

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:

Returns:

Exceptions:

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 3407 of file basic_string.h.

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:

Returns:

Exceptions:

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 3429 of file basic_string.h.

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 3468 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> const_reference std::basic_string< _CharT, _Traits, _Alloc >::back () const [inline], [noexcept]¶

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

Definition at line 3479 of file basic_string.h.

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 3144 of file basic_string.h.

Referenced by std::basic_string< char >::crend(), std::regex_match(), std::regex_replace(), std::regex_search(), and std::basic_string< char >::rend().

template<typename _CharT, typename _Traits, typename _Alloc> const_iterator std::basic_string< _CharT, _Traits, _Alloc >::begin () const [inline], [noexcept]¶

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

Definition at line 3155 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> const _CharT* std::basic_string< _CharT, _Traits, _Alloc >::c_str () const [inline], [noexcept]¶

Return const pointer to null-terminated contents. This is a handle to internal data. Do not modify or dire things may happen.

Definition at line 4366 of file basic_string.h.

Referenced by std::collate< _CharT >::do_compare(), std::money_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(), std::collate< _CharT >::do_transform(), std::messages< _CharT >::messages(), std::regex_replace(), and std::messages< _CharT >::~messages().

template<typename _CharT, typename _Traits, typename _Alloc> size_type std::basic_string< _CharT, _Traits, _Alloc >::capacity () const [inline], [noexcept]¶

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

Definition at line 3317 of file basic_string.h.

Referenced by std::basic_string< char >::push_back(), and std::basic_string< char >::shrink_to_fit().

template<typename _CharT, typename _Traits, typename _Alloc> const_iterator std::basic_string< _CharT, _Traits, _Alloc >::cbegin () const [inline], [noexcept]¶

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

Definition at line 3219 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> const_iterator std::basic_string< _CharT, _Traits, _Alloc >::cend () const [inline], [noexcept]¶

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

Definition at line 3227 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> void std::basic_string< _CharT, _Traits, _Alloc >::clear () [inline]¶

Erases the string, making it empty.

Definition at line 3345 of file basic_string.h.

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:

Returns:

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 4791 of file basic_string.h.

Referenced by std::basic_string< char >::compare(), std::operator<(), and std::operator<=().

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:

Returns:

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 1357 of file basic_string.tcc.

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) const¶

Compare substring to a substring.

Parameters:

Returns:

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 1372 of file basic_string.tcc.

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

Compare to a C string.

Parameters:

Returns:

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 1390 of file basic_string.tcc.

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:

Returns:

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 1405 of file basic_string.tcc.

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:

Returns:

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 1421 of file basic_string.tcc.

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:

Returns:

Exceptions:

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 1133 of file basic_string.tcc.

template<typename _CharT, typename _Traits, typename _Alloc> const_reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::crbegin () const [inline], [noexcept]¶

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 3236 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> const_reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::crend () const [inline], [noexcept]¶

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 3245 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> const _CharT* std::basic_string< _CharT, _Traits, _Alloc >::data () const [inline], [noexcept]¶

Return const pointer to contents. This is a handle to internal data. Do not modify or dire things may happen.

Definition at line 4376 of file basic_string.h.

Referenced by std::basic_regex< _Ch_type, _Rx_traits >::assign(), std::basic_string< char >::compare(), std::collate< _CharT >::do_compare(), std::money_get< _CharT, _InIter >::do_get(), std::collate< _CharT >::do_transform(), std::match_results< _Bi_iter >::format(), std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >::from_bytes(), std::operator<<(), std::operator==(), std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >::to_bytes(), and std::regex_traits< _Ch_type >::transform().

template<typename _CharT, typename _Traits, typename _Alloc> bool std::basic_string< _CharT, _Traits, _Alloc >::empty () const [inline], [noexcept]¶

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

Definition at line 3353 of file basic_string.h.

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 3163 of file basic_string.h.

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

template<typename _CharT, typename _Traits, typename _Alloc> const_iterator std::basic_string< _CharT, _Traits, _Alloc >::end () const [inline], [noexcept]¶

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

Definition at line 3174 of file basic_string.h.

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:

Returns:

Exceptions:

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 3924 of file basic_string.h.

Referenced by std::money_get< _CharT, _InIter >::do_get().

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

Remove one character.

Parameters:

Returns:

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

Definition at line 3940 of file basic_string.h.

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:

Returns:

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 831 of file basic_string.tcc.

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¶

Find position of a C substring.

Parameters:

Returns:

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 1178 of file basic_string.tcc.

Referenced by std::basic_string< char >::find(), std::basic_string< char >::find_first_of(), and std::basic_string< char >::get_allocator().

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 [inline], [noexcept]¶

Find position of a string.

Parameters:

Returns:

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 4412 of file basic_string.h.

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

Find position of a C string.

Parameters:

Returns:

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 4427 of file basic_string.h.

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:

Returns:

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 1201 of file basic_string.tcc.

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 [inline], [noexcept]¶

Find position of a character not in string.

Parameters:

Returns:

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 4645 of file basic_string.h.

Referenced by std::basic_string< char >::find_first_not_of().

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¶

Find position of a character not in C substring.

Parameters:

Returns:

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 1293 of file basic_string.tcc.

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 [inline]¶

Find position of a character not in C string.

Parameters:

Returns:

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 4676 of file basic_string.h.

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:

Returns:

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 1305 of file basic_string.tcc.

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 [inline], [noexcept]¶

Find position of a character of string.

Parameters:

Returns:

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 4518 of file basic_string.h.

Referenced by std::basic_string< char >::find_first_of().

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¶

Find position of a character of C substring.

Parameters:

Returns:

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 1257 of file basic_string.tcc.

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 [inline]¶

Find position of a character of C string.

Parameters:

Returns:

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 4548 of file basic_string.h.

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 [inline], [noexcept]¶

Find position of a character.

Parameters:

Returns:

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 4567 of file basic_string.h.

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 [inline], [noexcept]¶

Find last position of a character not in string.

Parameters:

Returns:

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 4708 of file basic_string.h.

Referenced by std::basic_string< char >::find_last_not_of().

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¶

Find last position of a character not in C substring.

Parameters:

Returns:

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 1316 of file basic_string.tcc.

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 [inline]¶

Find last position of a character not in C string.

Parameters:

Returns:

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 4739 of file basic_string.h.

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:

Returns:

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 1337 of file basic_string.tcc.

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 [inline], [noexcept]¶

Find last position of a character of string.

Parameters:

Returns:

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 4582 of file basic_string.h.

Referenced by std::basic_string< char >::find_last_of().

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¶

Find last position of a character of C substring.

Parameters:

Returns:

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 1272 of file basic_string.tcc.

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 [inline]¶

Find last position of a character of C string.

Parameters:

Returns:

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 4612 of file basic_string.h.

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 [inline], [noexcept]¶

Find last position of a character.

Parameters:

Returns:

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 4631 of file basic_string.h.

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 3446 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> const_reference std::basic_string< _CharT, _Traits, _Alloc >::front () const [inline], [noexcept]¶

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

Definition at line 3457 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> allocator_type std::basic_string< _CharT, _Traits, _Alloc >::get_allocator () const [inline], [noexcept]¶

Return copy of allocator used to construct this string.

Definition at line 4383 of file basic_string.h.

Referenced by std::basic_string< char >::assign(), std::basic_string< char >::basic_string(), std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >::from_bytes(), std::basic_string< char >::swap(), std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >::to_bytes(), and std::basic_string< char >::~basic_string().

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:

Exceptions:

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 3747 of file basic_string.h.

Referenced by std::money_get< _CharT, _InIter >::do_get(), and std::basic_string< char >::insert().

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:

Exceptions:

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 3764 of file basic_string.h.

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:

Exceptions:

Definition at line 3775 of file basic_string.h.

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:

Returns:

Exceptions:

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 3795 of file basic_string.h.

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) [inline]¶

Insert a substring.

Parameters:

Returns:

Exceptions:

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 3817 of file basic_string.h.

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:

Returns:

Exceptions:

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 800 of file basic_string.tcc.

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:

Returns:

Exceptions:

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 3858 of file basic_string.h.

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:

Returns:

Exceptions:

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 3881 of file basic_string.h.

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

Insert one character.

Parameters:

Returns:

Exceptions:

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 3899 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> size_type std::basic_string< _CharT, _Traits, _Alloc >::length () const [inline], [noexcept]¶

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

Definition at line 3260 of file basic_string.h.

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

template<typename _CharT, typename _Traits, typename _Alloc> size_type std::basic_string< _CharT, _Traits, _Alloc >::max_size () const [inline], [noexcept]¶

Returns the size() of the largest possible string.

Definition at line 3265 of file basic_string.h.

Referenced by std::getline().

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:

Returns:

Definition at line 3493 of file basic_string.h.

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:

Returns:

Definition at line 3502 of file basic_string.h.

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

Append a character.

Parameters:

Returns:

Definition at line 3511 of file basic_string.h.

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:

Returns:

Definition at line 3524 of file basic_string.h.

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:

Definition at line 3084 of file basic_string.h.

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:

Definition at line 3092 of file basic_string.h.

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:

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

Definition at line 3103 of file basic_string.h.

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

Move assign the value of str to this string.

Parameters:

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

Definition at line 3119 of file basic_string.h.

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:

Definition at line 3131 of file basic_string.h.

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

Subscript access to the data contained in the string.

Parameters:

Returns:

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 3368 of file basic_string.h.

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:

Returns:

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 3385 of file basic_string.h.

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 3969 of file basic_string.h.

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

Append a single character.

Parameters:

Definition at line 3613 of file basic_string.h.

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

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 3183 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> const_reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::rbegin () const [inline], [noexcept]¶

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 3192 of file basic_string.h.

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 3201 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> const_reverse_iterator std::basic_string< _CharT, _Traits, _Alloc >::rend () const [inline], [noexcept]¶

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 3210 of file basic_string.h.

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:

Returns:

Exceptions:

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 3994 of file basic_string.h.

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

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) [inline]¶

Replace characters with value from another string.

Parameters:

Returns:

Exceptions:

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 4016 of file basic_string.h.

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:

Returns:

Exceptions:

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 854 of file basic_string.tcc.

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:

Returns:

Exceptions:

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 4061 of file basic_string.h.

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:

Returns:

Exceptions:

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 4085 of file basic_string.h.

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:

Returns:

Exceptions:

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 4103 of file basic_string.h.

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:

Returns:

Exceptions:

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 4122 of file basic_string.h.

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:

Returns:

Exceptions:

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 4143 of file basic_string.h.

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:

Returns:

Exceptions:

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 4164 of file basic_string.h.

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:

Returns:

Exceptions:

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 4188 of file basic_string.h.

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:

Returns:

Exceptions:

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 4257 of file basic_string.h.

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

Attempt to preallocate enough memory for specified number of characters.

Parameters:

Exceptions:

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 942 of file basic_string.tcc.

Referenced by std::basic_string< char >::capacity(), std::money_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(), std::tr2::operator>>(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_string< char >::push_back(), and std::basic_string< char >::shrink_to_fit().

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:

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.

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

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:

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 3292 of file basic_string.h.

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 [inline], [noexcept]¶

Find last position of a string.

Parameters:

Returns:

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 4457 of file basic_string.h.

Referenced by std::basic_string< char >::find_last_of(), and std::basic_string< char >::rfind().

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¶

Find last position of a C substring.

Parameters:

Returns:

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 1219 of file basic_string.tcc.

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

Find last position of a C string.

Parameters:

Returns:

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 4487 of file basic_string.h.

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:

Returns:

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 1240 of file basic_string.tcc.

template<typename _CharT, typename _Traits, typename _Alloc> void std::basic_string< _CharT, _Traits, _Alloc >::shrink_to_fit () [inline], [noexcept]¶

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

Definition at line 3298 of file basic_string.h.

template<typename _CharT, typename _Traits, typename _Alloc> size_type std::basic_string< _CharT, _Traits, _Alloc >::size () const [inline], [noexcept]¶

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

Definition at line 3254 of file basic_string.h.

Referenced by std::basic_string< char >::append(), std::basic_regex< _Ch_type, _Rx_traits >::assign(), std::basic_string< char >::assign(), std::basic_string< char >::at(), std::basic_string< char >::cend(), std::basic_string< char >::clear(), std::basic_string< char >::compare(), std::money_get< _CharT, _InIter >::do_get(), std::basic_string< char >::empty(), std::basic_string< char >::end(), std::match_results< _Bi_iter >::format(), std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >::from_bytes(), std::operator<<(), std::operator==(), std::basic_string< char >::push_back(), std::basic_string< char >::shrink_to_fit(), std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >::to_bytes(), and std::regex_traits< _Ch_type >::transform().

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:

Returns:

Exceptions:

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 4772 of file basic_string.h.

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

Swap contents with another string.

Parameters:

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

Definition at line 959 of file basic_string.tcc.

Referenced by std::basic_string< char >::assign(), and std::basic_string< char >::operator=().

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 2816 of file basic_string.h.