STD::WSTRING(3cxx)
💖 std::basic_string< _CharT, _Traits, _Alloc > 💖
okay so this is the (3cxx) manual page bestie, and it's a big one — sit down, hydrate, we're doing this 🫶
✨ NAME ✨
std::basic_string< _CharT, _Traits, _Alloc > — managing sequences of characters and character-like objects. that's the whole job. that's the assignment. iconic behaviour, no notes. 💅
🌸 SYNOPSIS 🌸
#include <string>Inherited by __gnu_debug::basic_string< _CharT, _Traits, _Allocator >. just so u know who else is in the group chat 👀
🎀 Public Types 🎀
bestie, this is the type-alias lineup. every single one, exactly as written, no cap:
typedef _Alloc allocator_type— the allocator, as itself 💜typedef __gnu_cxx::__normal_iterator< const_pointer, basic_string > const_iterator— the const iterator, wrapped in the__gnu_cxxnormal_iterator situationtypedef _CharT_alloc_traits::const_pointer const_pointer— const pointer, straight from_CharT_alloc_traitstypedef const value_type & const_reference— a const reference to avalue_typetypedef std::reverse_iterator< const_iterator > const_reverse_iterator— reverse iterator but make it const, walk backwards bestie 🚶♀️typedef _CharT_alloc_traits::difference_type difference_type— difference type, courtesy of_CharT_alloc_traitstypedef __gnu_cxx::__normal_iterator< pointer, basic_string > iterator— the regular iterator, same normal_iterator vibetypedef _CharT_alloc_traits::pointer pointer— pointer, also from_CharT_alloc_traitstypedef value_type & reference— a plain reference to avalue_typetypedef std::reverse_iterator< iterator > reverse_iterator— reverse iterator, un-const editiontypedef _CharT_alloc_traits::size_type size_type— size type, again from_CharT_alloc_traits(she's everywhere and she's thriving) 🌈typedef _Traits traits_type— the traits, astraits_typetypedef _Traits::char_type value_type— and the actual character type lives at_Traits::char_type, which isvalue_type. yes, it's giving family tree 🌳
that's just the synopsis bestie, the rest is coming 👀💖
🎀 Public Member Functions 🎀
okay bestie, buckle up 💅 this is the whole member-function lineup — the entire friend group of basic_string. Every constructor, every find, every little noexcept she's wearing. No skipping, no summarizing, we're going through all of them fr fr. 🫶
basic_string () noexcept— the default constructor, makes you a cute empty string. minimal, iconic, does exactly what it says.template<class _InputIterator > basic_string (_InputIterator __beg, _InputIterator __end, const _Alloc &__a=_Alloc())— builds the string as a copy of a range ✨basic_string (basic_string &&__str) noexcept— the move constructor, she moves the string instead of copying. main character energy, no cap 🔥basic_string (basic_string &&__str, const _Alloc &__a)— no blurb in the original for this one, she's just living her truth 🙈basic_string (const _Alloc &__a)— constructs an empty string using allocator a. lowkey cozy.template<typename = _RequireAllocator<_Alloc>> basic_string (const _CharT *__s, const _Alloc &__a=_Alloc())— constructs the string as a copy of a C string 🎀basic_string (const _CharT *__s, size_type __n, const _Alloc &__a=_Alloc())— constructs the string initialized by a character arraytemplate<typename _Tp , typename = _If_sv<_Tp, void>> basic_string (const _Tp &__t, const _Alloc &__a=_Alloc())— constructs the string from astring_view🦋template<typename _Tp , typename = enable_if_t<is_convertible_v<const _Tp&, __sv_type>>> basic_string (const _Tp &__t, size_type __pos, size_type __n, const _Alloc &__a=_Alloc())— constructs the string from a substring of astring_viewbasic_string (const basic_string &__str)— copy constructor, constructs the string with a copy of the value of str. the classic 💖basic_string (const basic_string &__str, const _Alloc &__a)— again, no blurb in the original, she's just vibing 🌸basic_string (const basic_string &__str, size_type __pos, const _Alloc &__a=_Alloc())— constructs the string as a copy of a substringbasic_string (const basic_string &__str, size_type __pos, size_type __n)— constructs the string as a copy of a substring (yes, again, she has range)basic_string (const basic_string &__str, size_type __pos, size_type __n, const _Alloc &__a)— constructs the string as a copy of a substring, this time with an allocator toobasic_string (initializer_list< _CharT > __l, const _Alloc &__a=_Alloc())— constructs the string from an initializer list ✨basic_string (size_type __n, _CharT __c, const _Alloc &__a=_Alloc())— constructs the string as n copies of the character, multiple characters slay~basic_string () noexcept— the destructor, destroys the string instance. bye bestie, it's giving closure 💀template<typename _Operation > void __resize_and_overwrite (size_type __n, _Operation __op)— non-standard version ofresize_and_overwritefor C++11 and above. yes she's extra, that's the point 👑template<typename _InputIterator > basic_string< _CharT, _Traits, _Alloc > & _M_replace_dispatch (iterator __i1, iterator __i2, _InputIterator __k1, _InputIterator __k2, __false_type)— internal helper, no blurb in the original, we respect her privacy 🙈template<typename _InIterator > _CharT * _S_construct (_InIterator __beg, _InIterator __end, const _Alloc &__a, forward_iterator_tag)— another internal helper, also no blurb, also iconic
🌈 the append era 🌈
template<class _InputIterator > basic_string & append (_InputIterator __first, _InputIterator __last)— append a range of charactersbasic_string & append (const _CharT *__s)— append a C stringbasic_string & append (const _CharT *__s, size_type __n)— append a C substringtemplate<typename _Tp > _If_sv< _Tp, basic_string & > append (const _Tp &__svt)— append astring_view🦋template<typename _Tp > _If_sv< _Tp, basic_string & > append (const _Tp &__svt, size_type __pos, size_type __n=npos)— append a range of characters from astring_viewbasic_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=npos)— append a substringbasic_string & append (initializer_list< _CharT > __l)— append aninitializer_listof characters ✨basic_string & append (size_type __n, _CharT __c)— append multiple characters. she stacking them 🍓
🦋 the assign era 🦋
template<class _InputIterator > basic_string & assign (_InputIterator __first, _InputIterator __last)— set the value to a range of charactersbasic_string & assign (basic_string &&__str) noexcept(allocator_traits< _Alloc >::is_always_equal::value)— set the value to the contents of another string, and check out thatnoexceptclause 👀basic_string & assign (const _CharT *__s)— set the value to the contents of a C stringbasic_string & assign (const _CharT *__s, size_type __n)— set the value to a C substringtemplate<typename _Tp > _If_sv< _Tp, basic_string & > assign (const _Tp &__svt)— set the value from astring_viewtemplate<typename _Tp > _If_sv< _Tp, basic_string & > assign (const _Tp &__svt, size_type __pos, size_type __n=npos)— set the value from a range of characters in astring_viewbasic_string & assign (const basic_string &__str)— set the value to the contents of another string 🫶basic_string & assign (const basic_string &__str, size_type __pos, size_type __n=npos)— set the value to a substring of a stringbasic_string & assign (initializer_list< _CharT > __l)— set the value to aninitializer_listof charactersbasic_string & assign (size_type __n, _CharT __c)— set the value to multiple characters 💅
🎀 access + the basics 🎀
reference at (size_type __n)— provides access to the data contained in the string (and yes, she will check your bounds, behave)const_reference at (size_type __n) const— provides access to the data contained in the string, const editionreference back ()— no blurb in the original, just the back element doing her thingconst_reference back () const noexcept— same, but const andnoexceptiterator begin ()— the beginning iterator, no blurb needed, she's self-explanatoryconst_iterator begin () const noexcept— const begin,noexcept, slaying quietlyconst _CharT * c_str () const noexcept— return a const pointer to the null-terminated contents 🎀size_type capacity () const noexcept— no blurb in the original, she's just here holding the capacityconst_iterator cbegin () const noexcept— const begin again but with a c, iykykconst_iterator cend () const noexcept— the matching c-endvoid clear () noexcept— no blurb in the original, but the name says it all bestie 💀int compare (const _CharT *__s) const noexcept— compare to a C stringtemplate<typename _Tp > _If_sv< _Tp, int > compare (const _Tp &__svt) const noexcept(is_same< _Tp, __sv_type >::value)— compare to astring_viewint compare (const basic_string &__str) const— compare to a string 🌸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)— compare to astring_viewint compare (size_type __pos, size_type __n, const basic_string &__str) const— compare a substring to a stringint compare (size_type __pos, size_type __n1, const _CharT *__s) const— compare a substring to a C stringint compare (size_type __pos, size_type __n1, const _CharT *__s, size_type __n2) const— compare a substring against a character arraytemplate<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)— compare to astring_viewint compare (size_type __pos1, size_type __n1, const basic_string &__str, size_type __pos2, size_type __n2=npos) const— compare a substring to a substring, the deep-cut comparison 💅size_type copy (_CharT *__s, size_type __n, size_type __pos=0) const— copy a substring into a C stringconst_reverse_iterator crbegin () const noexcept— no blurb in the original, reverse const begin, she's backwards and proudconst_reverse_iterator crend () const noexcept— matching reverse const endconst _CharT * data () const noexcept— return a const pointer to the contents_CharT * data () noexcept— return a non-const pointer to the contents 👀bool empty () const noexcept— no blurb in the original, but she's checking if you're emptyiterator end ()— the end iterator, also self-explanatoryconst_iterator end () const noexcept— const end,noexceptbool ends_with (_CharT __x) const noexcept— no blurb in the original, but yes she checks the endingbool ends_with (basic_string_view< _CharT, _Traits > __x) const noexcept— same check,string_viewflavorbool ends_with (const _CharT *__x) const noexcept— same check, C-string flavor
✨ erase + find (the search party) ✨
iterator erase (iterator __first, iterator __last)— remove a range of charactersiterator erase (iterator __position)— remove one characterbasic_string & erase (size_type __pos=0, size_type __n=npos)— remove characterssize_type find (_CharT __c, size_type __pos=0) const noexcept— find the position of a charactersize_type find (const _CharT *__s, size_type __pos, size_type __n) const noexcept— find the position of a C substringsize_type find (const _CharT *__s, size_type __pos=0) const noexcept— find the position of a C stringtemplate<typename _Tp > _If_sv< _Tp, size_type > find (const _Tp &__svt, size_type __pos=0) const noexcept(is_same< _Tp, __sv_type >::value)— find the position of astring_viewsize_type find (const basic_string &__str, size_type __pos=0) const noexcept— find the position of a stringsize_type find_first_not_of (_CharT __c, size_type __pos=0) const noexcept— find the position of a different charactersize_type find_first_not_of (const _CharT *__s, size_type __pos, size_type __n) const noexcept— find the position of a character not in a C substringsize_type find_first_not_of (const _CharT *__s, size_type __pos=0) const noexcept— find the position of a character not in a C stringtemplate<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)— find the position of a character not in astring_viewsize_type find_first_not_of (const basic_string &__str, size_type __pos=0) const noexcept— find the position of a character not in a stringsize_type find_first_of (_CharT __c, size_type __pos=0) const noexcept— find the position of a charactersize_type find_first_of (const _CharT *__s, size_type __pos, size_type __n) const noexcept— find the position of a character of a C substringsize_type find_first_of (const _CharT *__s, size_type __pos=0) const noexcept— find the position of a character of a C stringtemplate<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)— find the position of a character of astring_viewsize_type find_first_of (const basic_string &__str, size_type __pos=0) const noexcept— find the position of a character of a stringsize_type find_last_not_of (_CharT __c, size_type __pos=npos) const noexcept— find the last position of a different charactersize_type find_last_not_of (const _CharT *__s, size_type __pos, size_type __n) const noexcept— find the last position of a character not in a C substringsize_type find_last_not_of (const _CharT *__s, size_type __pos=npos) const noexcept— find the last position of a character not in a C stringtemplate<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)— find the last position of a character not in astring_viewsize_type find_last_not_of (const basic_string &__str, size_type __pos=npos) const noexcept— find the last position of a character not in a stringsize_type find_last_of (_CharT __c, size_type __pos=npos) const noexcept— find the last position of a charactersize_type find_last_of (const _CharT *__s, size_type __pos, size_type __n) const noexcept— find the last position of a character of a C substring
okay bestie we're still deep in the member-function list and honestly? it's giving phonebook 📞 but every last one of these is a slay so let's keep going 💅
size_type find_last_of (const _CharT *__s, size_type __pos=npos) const noexcept— finds the last position of a character from a C string 🎀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)— finds the last position of a character from a string 🦋size_type find_last_of (const basic_string &__str, size_type __pos=npos) const noexcept— finds the last position of a character from a string (yes, again, but from an actualbasic_stringthis time) ✨reference front ()— no description on this one, the manpage is being mysterious 🙈const_reference front () const noexcept— same entry,constflavour, still no description 💀allocator_type get_allocator () const noexcept— hands you back a copy of the allocator that was used to construct this string 👑iterator insert (iterator __p, _CharT __c)— inserts one character, that's it, that's the whole job 🍓template<class _InputIterator > void insert (iterator __p, _InputIterator __beg, _InputIterator __end)— inserts a whole range of characters 🌈void insert (iterator __p, initializer_list< _CharT > __l)— inserts aninitializer_listof characters, curly-brace girlies rise 🌸void insert (iterator __p, size_type __n, _CharT __c)— inserts multiple characters, one of them,__ntimes 💜basic_string & insert (size_type __pos, const _CharT *__s)— inserts a C string 🫶basic_string & insert (size_type __pos, const _CharT *__s, size_type __n)— inserts a C substring ✨template<typename _Tp > _If_sv< _Tp, basic_string & > insert (size_type __pos, const _Tp &__svt)— inserts astring_view💅basic_string & insert (size_type __pos, size_type __n, _CharT __c)— inserts multiple characters (yep, this overload exists too, don't @ me) 🎀template<typename _Tp > _If_sv< _Tp, basic_string & > insert (size_type __pos1, const _Tp &__svt, size_type __pos2, size_type __n=npos)— inserts astring_viewbut you get to pick where the view starts and how much of it 🦋basic_string & insert (size_type __pos1, const basic_string &__str)— inserts the value of a string, iconic behaviour 👑basic_string & insert (size_type __pos1, const basic_string &__str, size_type __pos2, size_type __n=npos)— inserts a substring 🌸size_type length () const noexcept— returns the number of characters in the string, not including any null-termination, lowkey the most relatable function here 💖size_type max_size () const noexcept— returns thesize()of the biggest possible string, the theoretical maximum, main character energy 🔥operator __sv_type () const noexcept— converts to astring_view, glow-up complete ⭐basic_string & operator+= (_CharT __c)— appends a character 🍓basic_string & operator+= (const _CharT *__s)— appends a C string 🌈template<typename _Tp > _If_sv< _Tp, basic_string & > operator+= (const _Tp &__svt)— appends astring_view💜basic_string & operator+= (const basic_string &__str)— appends a string to this string, friendship bracelet style 🫶basic_string & operator+= (initializer_list< _CharT > __l)— appends aninitializer_listof characters ✨basic_string & operator= (_CharT __c)— sets the value to a string of length 1, tiny but mighty 🎀basic_string & operator= (basic_string &&__str) noexcept(/*conditional */)— move-assigns the value of__strinto this string 🦋basic_string & operator= (const _CharT *__s)— copies the contents of__sinto this string 📋template<typename _Tp > _If_sv< _Tp, basic_string & > operator= (const _Tp &__svt)— sets the value to a string constructed from astring_view💅basic_string & operator= (const basic_string &__str)— assigns the value of__strto this string 👑basic_string & operator= (initializer_list< _CharT > __l)— sets the value to a string constructed from an initializer list 🌸reference operator[] (size_type __pos)— subscript access to the data contained in the string, the classic 🎟️const_reference operator[] (size_type __pos) const noexcept— subscript access to the data contained in the string, butconstandnoexcept, so it's extra composed about it ✨void pop_back ()— removes the last character. bye bestie 👋💀void push_back (_CharT __c)— appends a single character, the itty bitty addition 🍓reverse_iterator rbegin ()— no description in the source, it's just out here existing 🙈const_reverse_iterator rbegin () const noexcept— theconsttwin, equally undescribed 🫶reverse_iterator rend ()— also no description, living its truth 🌈const_reverse_iterator rend () const noexcept— and itsconstcounterpart, also just vibing 💜template<typename _Tp > _If_sv< _Tp, basic_string & > replace (const_iterator __i1, const_iterator __i2, const _Tp &__svt)— replaces a range of characters with astring_view🔁basic_string & replace (iterator __i1, iterator __i2, _CharT *__k1, _CharT *__k2)— no description given, it's giving mystery 🎀template<class _InputIterator > basic_string & replace (iterator __i1, iterator __i2, _InputIterator __k1, _InputIterator __k2)— replaces a range of characters with a range ✨basic_string & replace (iterator __i1, iterator __i2, const _CharT *__k1, const _CharT *__k2)— again, no description, the manpage said "figure it out" 💀basic_string & replace (iterator __i1, iterator __i2, const _CharT *__s)— replaces a range of characters with a C string 🌸basic_string & replace (iterator __i1, iterator __i2, const _CharT *__s, size_type __n)— replaces a range of characters with a C substring 🦋basic_string & replace (iterator __i1, iterator __i2, const basic_string &__str)— replaces a range of characters with a string 👑basic_string & replace (iterator __i1, iterator __i2, const_iterator __k1, const_iterator __k2)— no description, just signatures, we move 💅basic_string & replace (iterator __i1, iterator __i2, initializer_list< _CharT > __l)— replaces a range of characters with aninitializer_list🍓basic_string & replace (iterator __i1, iterator __i2, iterator __k1, iterator __k2)— no description either, the silence is loud 😭basic_string & replace (iterator __i1, iterator __i2, size_type __n, _CharT __c)— replaces a range of characters with multiple characters 🌈template<typename _Tp > _If_sv< _Tp, basic_string & > replace (size_type __pos, size_type __n, const _Tp &__svt)— replaces a range of characters with astring_view💜basic_string & replace (size_type __pos, size_type __n, const basic_string &__str)— replaces characters with the value from another string ✨basic_string & replace (size_type __pos, size_type __n1, const _CharT *__s)— replaces characters with the value of a C string 🎀basic_string & replace (size_type __pos, size_type __n1, const _CharT *__s, size_type __n2)— replaces characters with the value of a C substring 🦋basic_string & replace (size_type __pos, size_type __n1, size_type __n2, _CharT __c)— replaces characters with multiple characters 🔁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)— replaces a range of characters with astring_view, with positions on both sides 👑basic_string & replace (size_type __pos1, size_type __n1, const basic_string &__str, size_type __pos2, size_type __n2=npos)— replaces characters with the value from another string 💖void reserve ()— equivalent toshrink_to_fit(). yes, the no-arg one. that's what it says. no notes. 💀void reserve (size_type __res_arg)— tries to preallocate enough memory for the specified number of characters 🔥void resize (size_type __n)— resizes the string to the specified number of characters 📏void resize (size_type __n, _CharT __c)— resizes the string to the specified number of characters, with a character to fill with 🌸size_type rfind (_CharT __c, size_type __pos=npos) const noexcept— finds the last position of a character 🔍size_type rfind (const _CharT *__s, size_type __pos, size_type __n) const noexcept— finds the last position of a C substring 🦋size_type rfind (const _CharT *__s, size_type __pos=npos) const noexcept— finds the last position of a C string ✨template<typename _Tp > _If_sv< _Tp, size_type > rfind (const _Tp &__svt, size_type __pos=npos) const noexcept(is_same< _Tp, __sv_type >::value)— finds the last position of astring_view💅size_type rfind (const basic_string &__str, size_type __pos=npos) const noexcept— finds the last position of a string 🎀void shrink_to_fit () noexcept— a non-binding request to reducecapacity()down tosize(), so it's a suggestion, not a command, respect its boundaries 🫶size_type size () const noexcept— returns the number of characters in the string, not including any null-termination, the moment of truth 💖bool starts_with (_CharT __x) const noexcept— no description given, but the name is not subtle 🍓bool starts_with (basic_string_view< _CharT, _Traits > __x) const noexcept— also undescribed, also pretty self-explanatory 🌈bool starts_with (const _CharT *__x) const noexcept— third one, same energy ⭐basic_string substr (size_type __pos=0, size_type __n=npos) const— gets you a substring, the little slice of the original 🍰void swap (basic_string &__s) noexcept(/*conditional */)— swaps contents with another string, consensual and mutual obviously 💜
✨ Static Public Attributes ✨
static const size_type npos— the value returned by various member functions when they fail 😭 literally the "idk bestie, didn't find it" of the string world.
🎀 Protected Types 🎀
typedef iterator __const_iterator— that's the whole entry, no extra lore 🌸
💖 Detailed Description 💖
template<typename _CharT, typename _Traits, typename _Alloc>
class std::basic_string< _CharT, _Traits, _Alloc >Managing sequences of characters and character-like objects. that's the whole mission statement, and it ate 👑
Since — C++98. an elder. a legend. respect the elders 🫶
🌟 Template Parameters 🌟
_CharT— type of character 🍓_Traits— traits for the character type, defaults tochar_traits<_CharT>🦋_Alloc— allocator type, defaults toallocator<_CharT>💜
It 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 — so like, not everything optional is on the menu, just those three ✨
Todo — Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html 😭 the todo is literally "document this", iconic honesty.
Documentation? What's that? — Nathan Myers ncm@cantrip.org. a real quote, from a real person, and honestly? same energy 🫶
A string looks like this:
[_Rep]
_M_length
[basic_string<char_type>] _M_capacity
_M_dataplus _M_refcount
_M_p ----------------> unnamed array of char_typeWhere 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. yes, subtract one, that's the trick, it's giving "the header is hiding right behind the vibes" 🕵️
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. one allocation. one. that's the whole flex 💅
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.) — that's their note, not mine, I'm just delivering it 🫡
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 🧚 no cap, zero means one here, that's not a typo, that's the encoding.
All but the last paragraph is considered pretty conventional for a Copy-On-Write C++ string implementation 🌈 and that's the vibe check on the internal layout, bestie.
💅 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 💅
okay bestie, this is the part where we meet every single way you can birth a std::basic_string. there are a LOT of them. like, an unreasonable amount. but each one is iconic in its own way, so let's go 🫶
🎀 the default girlie: basic_string()
template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string () [inline],
[noexcept]Default constructor, and she creates an empty string. that's it, that's the whole vibe. no cap. it's [noexcept] too, so she will not be throwing hands 💅
Referenced by std::basic_string< _CharT, _Traits, _Alloc >::substr().
🧚 the allocator one: basic_string(const _Alloc & __a)
template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string (const _Alloc
& __a) [inline], [explicit]Construct an empty string, but using allocator __a. note the [explicit] bestie — she does not do sneaky conversions, you have to mean it ✨
🦋 the copy ctor: basic_string(const basic_string & __str)
template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::basic_string (const
basic_string< _CharT, _Traits, _Alloc > & __str) [inline]Construct a string with a copy of the value of __str. so like... a whole new string, same energy 💖
Parameters
__str— source string. the original. the blueprint.
🌸 copy-a-substring, allocator edition
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 a string as a copy of a substring. you're taking a slice, but make it fashion 💅
Parameters
__str— source string.__pos— index of the first character to copy from.__a— allocator to use.
🍓 copy-a-substring, with a length
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 a string as a copy of a substring — this time you're also telling it exactly how many characters you want.
Parameters
__str— source string.__pos— index of the first character to copy from.__n— number of characters to copy.
🧁 copy-a-substring, with a length and an allocator
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 a string as a copy of a substring — the full package: position, length, allocator. she has everything 😭👑
Parameters
__str— source string.__pos— index of the first character to copy from.__n— number of characters to copy.__a— allocator to use.
🔥 from a character array: basic_string(const _CharT * __s, size_type __n, const _Alloc & __a = _Alloc())
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 a string initialized by a character array.
Parameters
__s— source character array.__n— number of characters to copy.__a— allocator to use (default is default allocator).
⚠️ NB:__smust have at least__ncharacters, and'\0'has no special meaning here. read that again, bestie — no sneaky null-terminator behaviour, she will read right past it 💀
⭐ from a C string: the _RequireAllocator one
template<typename _CharT , typename _Traits , typename _Alloc >
template<typename = _RequireAllocator<_Alloc>> std::basic_string<
_CharT, _Traits, _Alloc >::basic_string (const _CharT * __s, const
_Alloc & __a = _Alloc()) [inline]Construct a string as a copy of a C string. this one does respect the C-string rules, iykyk 🎀
Parameters
__s— source C string.__a— allocator to use (default is default allocator).
🌈 fill it up: basic_string(size_type __n, _CharT __c, const _Alloc & __a = _Alloc())
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 a string as multiple characters — same character, __n times. it's giving "repeated emoji" energy 💖💖💖
Parameters
__n— number of characters.__c— character to use.__a— allocator to use (default is default allocator).
🦄 the move ctor: basic_string(basic_string && __str)
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. she's [noexcept], she's efficient, she's that girl ✨
Parameters
__str— source string.
The newly-created string contains the exact contents of __str. after the move, __str is a valid, but unspecified string. so like... she's still alive, she's just not telling you what she's wearing anymore 🙈
🎀 from an initializer list
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. brace-init besties rise 🫶
Parameters
__l—std::initializer_listof characters.__a— allocator to use (default is default allocator).
🧚 from an iterator range
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 a copy of a range. give her a begin and an end and she'll handle the rest 💅
Parameters
__beg— start of range.__end— end of range.__a— allocator to use (default is default allocator).
🔮 substring of a string_view-convertible thing
template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Tp , typename = enable_if_t<is_convertible_v<const
_Tp&, __sv_type>>> 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. yes the template constraint is unhinged, no we're not scared of it 😭
Parameters
__t— source object convertible to string view.__pos— the index of the first character to copy from__t.__n— the number of characters to copy from__t.__a— allocator to use.
🌟 from a string_view, the explicit one
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()) [inline], [explicit]Construct string from a string_view. flagged [explicit] so nobody converts by accident — consent matters, bestie 🫶
Parameters
__t— source object convertible to string view.__a— allocator to use (default is default allocator).
💀 the end of an era: ~basic_string()
template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::~basic_string () [inline],
[noexcept]Destroy the string instance. goodbye queen, you served 💅 [noexcept] so she leaves peacefully.
References std::basic_string< _CharT, _Traits, _Alloc >::get_allocator().
👑 MEMBER FUNCTION DOCUMENTATION 👑
🧁 __resize_and_overwrite (the non-standard one)
template<typename _CharT , typename _Traits , typename _Alloc >
template<typename _Operation > void std::basic_string< _CharT, _Traits,
_Alloc >::__resize_and_overwrite (size_type __n, _Operation __op)Non-standard version of resize_and_overwrite for C++11 and above. yes the double underscore is right there in the name — she's an internal icon, not a public one 🌈
🌸 append(_InputIterator __first, _InputIterator __last)
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. appends characters in the range [__first,__last) to this string 🔥
Parameters
__first— iterator referencing the first character to append.__last— iterator marking the end of the range.
Returns — reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::replace().
🦋 append(const _CharT * __s)
template<typename _CharT , typename _Traits , typename _Alloc > basic_string
& std::basic_string< _CharT, _Traits, _Alloc >::append (const _CharT *
__s) [inline]Append a C string. classic. reliable. never misses ✨
Parameters
__s— the C string to append.
Returns — reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::append().
🍓 append(const _CharT * __s, size_type __n)
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 — the C string's cousin who actually tells you how many characters she's bringing 💅
Parameters
__s— the C string to append.__n— the number of characters to append.
Returns — reference to this string.
References std::size().
🧚 append(const _Tp & __svt)
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 — well, append anything convertible to one 🫶
Parameters
__svt— the object convertible tostring_viewto be appended.
Returns — reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::append().
🎀 append(const _Tp & __svt, size_type __pos, size_type __n = npos)
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. note the default __n = npos — she'll take as much as she can unless you say otherwise 🌟
Parameters
__svt— the object convertible tostring_viewto be appended from.__pos— the position in thestring_viewto append from.__n— the number of characters to append from thestring_view.
Returns — reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::append().
🔥 append(const basic_string & __str)
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. the main character overload, fr fr 👑
Parameters
__str— the string to append.
Returns — reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::size(), and std::size().
Referenced by std::basic_string< _CharT, _Traits, _Alloc >::append(), std::basic_string< _CharT, _Traits, _Alloc >::append(), std::basic_string< _CharT, _Traits, _Alloc >::append(), std::basic_string< _CharT, _Traits, _Alloc >::append(), std::collate< _CharT >::do_transform(), std::basic_string< _CharT, _Traits, _Alloc >::operator+=(), std::basic_string< _CharT, _Traits, _Alloc >::operator+=(), std::basic_string< _CharT, _Traits, _Alloc >::operator+=(), std::basic_string< _CharT, _Traits, _Alloc >::operator+=(), and std::operator>>().
(yes, append() appears four times and operator+=() appears four times in that list. that's literally what the page says, bestie — we do not editorialise 💀)
💜 append(const basic_string & __str, size_type __pos, size_type __n = npos)
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. this is the one with rules, so listen up 🫶
Parameters
__str— the string to append.__pos— index of the first character ofstrto append.__n— the number of characters to append.
Returns — reference to this string.
Exceptions
std::out_of_rangeif__posis 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. (and yes, "is is" is in the original — she's quirky like that 😭)
References std::size().
⭐ append(initializer_list< _CharT > __l)
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. curly braces gang, we stay winning 🎀
Parameters
__l— theinitializer_listof characters to append.
Returns — reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::append().
🌈 append(size_type __n, _CharT __c)
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 — one character, __n copies of it. the "spam the same emoji" pipeline 💖💖💖
Parameters
__n— the number of characters to append.__c— the character to use.
Returns — reference to this string.
Appends __n copies of __c to this string. 🎀
🔗 References std::size().
🦋 assign — the iterator-range glow-up
template<typename _CharT , typename _Traits , typename _Alloc >
template<class _InputIterator >
basic_string & std::basic_string< _CharT, _Traits, _Alloc >::assign
(_InputIterator __first, _InputIterator __last) [inline]Bestie, this one sets the value of your string to a whole range of characters. Iconic behaviour, no notes. ✨
Parameters
__first— iterator pointing at the first character to append.__last— iterator marking the end of the range.
Returns — a reference to this string, so you can keep chaining like the main character you are.
Sets the value of the string to the characters in the range [__first,__last).
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::replace().
💅 assign — move edition, the speedy one
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string & std::basic_string< _CharT, _Traits, _Alloc >::assign
(basic_string< _CharT, _Traits, _Alloc > && __str) [inline], [noexcept]Grabs the contents of another string and makes them yours. Marked [noexcept] so it literally cannot throw at you — a whole vibe. 🔥
Parameters
__str— the source string to use.
Returns — reference to this string. 🫶
So here's the tea: this function sets this string to the exact contents of __str. After that, __str is a valid, but unspecified string — meaning it still, like, exists and everything, it's just not telling you what's in it anymore. 🙈
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::swap().
🌸 assign — from a C string
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string & std::basic_string< _CharT, _Traits, _Alloc >::assign
(const _CharT * __s) [inline]Parameters
__s— the C string to use.
Returns — reference to this string, bestie.
This sets the value of this string to the value of __s. And the data is copied, so once the function returns there's zero dependence on __s — you can free it, scribble on it, do whatever, the string already has its own copy. 😌
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::assign().
🧚 assign — C substring, take __n characters
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)Parameters
__s— the C string to use.__n— number of characters to use.
Returns — reference to this string. 💖
Sets the value of this string to the first __n characters of __s. And if __n is larger than the number of available characters in __s? Then the remainder of __s is used. It just takes what it can get, honestly relatable. 💀
🔗 References std::size().
🎀 assign — from a string_view
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]Parameters
__svt— the source object convertible tostring_view.
Returns — reference to this string. ✨
Note the return type: _If_sv< _Tp, basic_string & > — that's the little SFINAE gatekeeper making sure __svt really is convertible to a string_view before this overload even shows up. Gatekeeping, but make it template magic. 👑
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::assign().
🍓 assign — from a range inside a string_view
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]Parameters
__svt— the source object convertible tostring_view.__pos— the position in thestring_viewto assign from.__n— the number of characters to assign. Defaults tonpos, which is the "just give me everything from here" default. 🌈
Returns — reference to this string.
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::assign().
👑 assign — copy from another string
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)Parameters
__str— the source string to use.
Returns — reference to this string. 🫶
The plain old "set value to contents of another string" moment. Nothing flashy, just reliable. And this one is a very popular function internally — literally everybody's referencing it:
Referenced by:
std::basic_string< _CharT, _Traits, _Alloc >::assign()×5 (yes, five of them — the overloads all lean on this one)std::basic_string< _CharT, _Traits, _Alloc >::operator=()×5std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow()std::basic_stringbuf< _CharT, _Traits, _Alloc >::str()std::basic_stringbuf< _CharT, _Traits, _Alloc >::str()(again — two of them)
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::get_allocator().
🌟 assign — substring of a string, with the pos/n dance
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]Parameters
__str— the string to use.__pos— index of the first character ofstr.__n— number of characters to use. Defaults tonpos. ✨
Returns — reference to this string.
Exceptions — std::out_of_range if pos is not a valid index. So like, behave. 😭
Sets this string to the substring of __str consisting of __n characters at __pos. If __n is larger than the number of available characters in __str, the remainder of __str is used — it's flexible like that, lowkey generous.
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::assign().
🌸 assign — initializer_list moment
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string & std::basic_string< _CharT, _Traits, _Alloc >::assign
(initializer_list< _CharT > __l) [inline]Parameters
__l— theinitializer_listof characters to assign.
Returns — reference to this string. 🎀
Brace-init your way into a string's soul, iykyk.
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::assign().
💜 assign — repeat a character __n times
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string & std::basic_string< _CharT, _Traits, _Alloc >::assign
(size_type __n, _CharT __c) [inline]Parameters
__n— length of the resulting string.__c— the character to use.
Returns — reference to this string.
Sets the value of this string to __n copies of character __c. It's giving "spam one emoji until it becomes a personality". 🦋
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::size().
🔥 at — the safe one (non-const)
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, but like… responsibly. 💅
Parameters
__n— the index of the character to access.
Returns — read/write reference to the character.
Exceptions — std::out_of_range if n is an invalid index. 🚨
This function provides for safer data access. The parameter is first checked to make sure it's actually in the range of the string. If the check fails, the function throws out_of_range. And on success? Success results in unsharing the string. Noted, bestie — that's a real side effect, not just a vibe.
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::size().
🧊 at — the safe one, but const
template<typename _CharT , typename _Traits , typename _Alloc >
const_reference std::basic_string< _CharT, _Traits, _Alloc >::at
(size_type __n) const [inline]Parameters
__n— the index of the character to access.
Returns — read-only (const) reference to the character.
Exceptions — std::out_of_range if n is an invalid index. 😭
Same safer-data-access situation: the parameter is checked against the range of the string first, and if the check fails it throws out_of_range. Look at you doing bounds-checking like a responsible adult. 🫶
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::size().
🍓 back — last character, read/write
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. Main character energy, literally the final girl of the string. 👑
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::empty(), std::basic_string< _CharT, _Traits, _Alloc >::operator[](), and std::basic_string< _CharT, _Traits, _Alloc >::size().
🧊 back — last character, const
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. And it's [noexcept], so it's not gonna pop off with an exception. 💀
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::empty(), std::basic_string< _CharT, _Traits, _Alloc >::operator[](), and std::basic_string< _CharT, _Traits, _Alloc >::size().
🌈 begin — iterator to the first character, read/write
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. And heads up: unshares the string. ✨
Referenced by: std::basic_string< _CharT, _Traits, _Alloc >::crend(), std::regex_match() (×2), std::regex_replace() (×2), std::regex_search(), std::basic_string< _CharT, _Traits, _Alloc >::rend() (×2), and std::basic_string< _CharT, _Traits, _Alloc >::replace().
The regex girlies stay calling on this one, no cap.
🧊 begin — iterator to the first character, const
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. [noexcept] too — calm, collected, throwing nothing. 🫶
🎀 c_str — the classic
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. 🦋
⚠️ Okay bestie, listen: this is a handle to internal data. Do not modify it or dire things may happen. I'm serious. Do not touch. 💀
Referenced by: std::collate< _CharT >::do_compare(), std::money_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get() (×3), std::collate< _CharT >::do_transform(), std::basic_filebuf< _CharT, _Traits >::open(), std::regex_replace(), and std::experimental::filesystem::v1::filesystem_error::what().
🌟 capacity — how much room before reallocation
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. It's the "how much space do I have in my bag before I have to check it" of functions. 👜
Referenced by: std::basic_string< _CharT, _Traits, _Alloc >::push_back().
🧚 cbegin — const iterator to the first character
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. Yes it's basically begin() const, but the c is for commitment. 💅
🍓 cend — const iterator, one past the last character
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. Your classic half-open-range ending, standing just outside the party like a bodyguard. 🫶
🔗 References std::basic_string< _CharT, _Traits, _Alloc >::size().
clear() 🧹
template<typename _CharT , typename _Traits , typename _Alloc > void
std::basic_string< _CharT, _Traits, _Alloc >::clear () [inline],
[noexcept]okay bestie, this one is SO simple and so satisfying — it erases the string, making it empty. that's it. that's the whole vibe. your string goes from main character to absolutely nothing ✨
it's [inline] and [noexcept], so it's fast and it will never, ever throw at you. love that for us 💅
References: std::basic_string< _CharT, _Traits, _Alloc >::get_allocator().
Referenced by: std::basic_stringbuf< _CharT, _Traits, _Alloc >::setbuf().
compare() — the overload that checks you against a C string 🔍
template<typename _CharT , typename _Traits , typename _Alloc > int
std::basic_string< _CharT, _Traits, _Alloc >::compare (const _CharT *
__s) const [inline], [noexcept]literally the "who's better, me or that C string?" function. it's [inline] and [noexcept] — no drama, no throws 💖
Parameters
__s— the C string you're comparing against.
Returns
- Integer
< 0,0, or> 0.
so it 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. and how does it decide? it determines the effective length rlen of the strings to compare as the smallest of size() and the length of a string constructed from __s. then 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. iconic tie-break behaviour, ngl 🎀
References: std::min(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
compare() — the string_view one 🦋
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 [inline],
[noexcept]same energy, but against a string_view. [inline], [noexcept], chef's kiss 💅
Parameters
__svt— an object convertible tostring_viewto compare against.
Returns
- Integer
< 0,0, or> 0.
References: std::min(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
compare() — the string-to-string classic 👑
template<typename _CharT , typename _Traits , typename _Alloc > int
std::basic_string< _CharT, _Traits, _Alloc >::compare (const
basic_string< _CharT, _Traits, _Alloc > & __str) const [inline]comparing a string to a string. the original. the blueprint. [inline] and no [noexcept] listed here, fyi 🙈
Parameters
__str— the string 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. the effective length is determined as the smallest of size() and str.size(), then it 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. periodt 💜
References: std::basic_string< _CharT, _Traits, _Alloc >::data(), std::min(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
compare() — substring vs. a string_view 🌸
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 [inline], [noexcept]now we're slicing. [inline] + [noexcept] obviously 🫶
Parameters
__pos— a position in the string to start comparing from.__n— the number of characters to compare.__svt— an object convertible tostring_viewto compare against.
Returns
- Integer
< 0,0, or> 0.
compare() — substring vs. a full string ✂️
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 [inline]Parameters
__pos— index of first character of substring.__n— number of characters in substring.__str— the string to compare against.
Returns
- Integer
< 0,0, or> 0.
the whole deal: form the substring of this string from the __n characters starting at __pos. then 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. effective length rlen is the smallest of the length of the substring and __str.size(). then it 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. no cap, this is the good stuff 🔥
References: std::basic_string< _CharT, _Traits, _Alloc >::data(), std::min(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
compare() — substring vs. C string 🎀
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 [inline]Parameters
__pos— index of first character of substring.__n1— number of characters in substring.__s— the C string to compare against.
Returns
- Integer
< 0,0, or> 0.
Form the substring of this string from the __n1 characters starting at pos. (yes, the docs say pos there — copying the manpage's words exactly, bestie, don't come for me 😭) 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. effective length rlen = the smallest of the length of the substring and the length of a string constructed from __s. then 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. 💖
References: std::min().
compare() — substring vs. character array 🍓
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 [inline]Parameters
__pos— index of first character of substring.__n1— number of characters in substring.__s— the character array to compare against.__n2— number of characters ofs.
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. then 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. effective length rlen = the smallest of the length of the substring and __n2. then 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:smust have at leastn2characters,'\0'has no special meaning. ⚠️ read that twice, bestie — a null terminator does NOT save you here.
References: std::min().
compare() — substring vs. string_view with a start pos 💫
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 [inline],
[noexcept]double-slicing, double the fun ✨ [inline] + [noexcept], and __n2 defaults to npos.
Parameters
__pos1— a position in the string to start comparing from.__n1— the number of characters to compare.__svt— an object convertible tostring_viewto compare against.__pos2— a position in thestring_viewto start comparing from.__n2— the number of characters to compare.
Returns
- Integer
< 0,0, or> 0.
compare() — substring vs. substring, the final boss 👑💅
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 [inline]Parameters
__pos1— index of first character of substring.__n1— number of characters in substring.__str— the string to compare against.__pos2— index of first character of substring ofstr.__n2— number of characters in substring ofstr.
Returns
- Integer
< 0,0, or> 0.
here's the tea: 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. then 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. effective length rlen = the smallest of the lengths of the substrings. then 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. ate and left no crumbs 🔥
References: std::basic_string< _CharT, _Traits, _Alloc >::data(), and std::min().
copy() — steal a chunk into a C string 📋
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) constcopy substring into C string, no null-terminator shenanigans implied — you get raw characters, bestie 💖
Parameters
__s— the C string to copy value into.__n— number of characters to copy.__pos— index of first character to copy.
note that __pos has a default of 0 — so if you don't say where to start, it starts at the beginning like a well-behaved icon ✨
Returns
- Number of characters actually copied.
Exceptions
std::out_of_range— if__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. so like… watch your indexes, okay? 😭
crbegin() — backwards but make it read-only 🔄
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. lowkey the cutest way to walk a string backwards 🦋 [inline], [noexcept], const-correct, flawless.
References: std::basic_string< _CharT, _Traits, _Alloc >::end().
crend() — the backwards end-of-the-line 🌈
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. it's the pairing to crbegin() — one before the first character, which is exactly the "stop here" marker for a reverse loop 🎀
References: std::basic_string< _CharT, _Traits, _Alloc >::begin().
data() — gimme the pointer, but const 🫶
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 pointer to internal data. It is undefined to modify the contents through the returned pointer.
⚠️ undefined behaviour alert — do NOT write through this pointer. it's giving "look, don't touch" 💀
To get a pointer that allows modifying the contents use &str[0] instead, (or in C++17 the non-const str.data() overload). there's your workaround, bestie, you're welcome 💜
std::basic_regex< _Ch_type, _Rx_traits >::assign()std::basic_string< _CharT, _Traits, _Alloc >::compare()std::basic_string< _CharT, _Traits, _Alloc >::compare()std::basic_string< _CharT, _Traits, _Alloc >::compare()std::collate< _CharT >::do_compare()std::collate< _CharT >::do_transform()std::basic_string< _CharT, _Traits, _Alloc >::find()std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of()std::basic_string< _CharT, _Traits, _Alloc >::find_first_of()std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of()std::basic_string< _CharT, _Traits, _Alloc >::find_last_of()std::match_results< _Bi_iter, _Alloc >::format()std::basic_string< _CharT, _Traits, _Alloc >::operator __sv_type()std::basic_string< _CharT, _Traits, _Alloc >::rfind()std::basic_stringbuf< _CharT, _Traits, _Alloc >::str()std::regex_traits< _Ch_type >::transform()
🫶 data() — the non-const glow-up
template<typename _CharT , typename _Traits , typename _Alloc > _CharT *
std::basic_string< _CharT, _Traits, _Alloc >::data () [inline], [noexcept]Okay bestie, this is the non-const version of data(), and it's giving main character energy ✨ It hands you back a pointer to the character sequence that the string is literally holding. And yes — modifying the characters in that sequence is allowed. Go off. 💅
🦋 empty() — is it literally nothing
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. That's it, that's the whole vibe. Equivalent to *this == ''. 🎀
References: std::basic_string< _CharT, _Traits, _Alloc >::size()
Referenced by:
std::basic_string< _CharT, _Traits, _Alloc >::back()std::basic_string< _CharT, _Traits, _Alloc >::back()std::basic_string< _CharT, _Traits, _Alloc >::front()std::basic_string< _CharT, _Traits, _Alloc >::front()std::tr2::operator>>()std::basic_string< _CharT, _Traits, _Alloc >::pop_back()
🧚 end() (the spicy read/write one)
template<typename _CharT , typename _Traits , typename _Alloc > iterator
std::basic_string< _CharT, _Traits, _Alloc >::end () [inline]Slides you a read/write iterator that points one past the last character in the string. And lowkey important: it unshares the string. Not me warning you — it's right there in the docs, iykyk. 🙈
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::basic_string< _CharT, _Traits, _Alloc >::rbegin()std::regex_match()std::regex_match()std::regex_replace()std::regex_replace()std::regex_search()
💜 end() const — the chill read-only twin
template<typename _CharT , typename _Traits , typename _Alloc >
const_iterator std::basic_string< _CharT, _Traits, _Alloc >::end ()
const [inline], [noexcept]Same one-past-the-last-character energy, but read-only (constant) this time. No touching, just looking. Respect the boundary bestie. 🎀
References: std::basic_string< _CharT, _Traits, _Alloc >::size()
💀 erase() — the range version (be careful, this eats characters)
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. Poof. Gone. 😭
Parameters:
__first— iterator referencing the first character to remove.__last— iterator referencing the end of the range.
Returns: an iterator referencing the location of the first character after removal.
So it removes the characters in the range [first,last) from this string. And here's the reassure-her moment: the value of the string doesn't change if an error is thrown. Safe-ish. 🫶
🌸 erase() — the single-character version
template<typename _CharT , typename _Traits , typename _Alloc > iterator
std::basic_string< _CharT, _Traits, _Alloc >::erase (iterator
__position) [inline]Remove one character. Just the one. Petty and precise. 💅
Parameters:
__position— iterator referencing the character to remove.
Returns: an iterator referencing the same location after removal.
Removes the character at __position from this string. And same deal as before: the value of the string doesn't change if an error is thrown. ✨
🔥 erase() — the index-and-count version
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. Plural. The full sweep. 👑
Parameters:
__pos— index of the first character to remove (default0).__n— number of characters to remove (default remainder).
Returns: a reference to this string.
Exceptions: std::out_of_range if pos is beyond the end of this string.
So what it does: removes __n characters from this string starting at __pos. The length of the string is reduced by __n. If there are fewer than __n characters to remove, the remainder of the string is truncated. If __p is beyond the end of the string, out_of_range is thrown. And yes, the value of the string doesn't change if an error is thrown. 💖
ngl, that __p in the exception note is exactly how the page spells it — not a typo on my end, I'm just repeating it fr fr.
Referenced by:
std::getline()std::operator>>()std::basic_string< _CharT, _Traits, _Alloc >::pop_back()
🍓 find() — locating a single character
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 the position of a character. Detective mode activated 🔍
Parameters:
__c— character to locate.__pos— index of the character to search from (default0).
Returns: index of the first occurrence.
Starting from __pos, it searches forward for __c within this string. If it's found, you get the index where it was found. If not found — you get npos. (Cruel but fair. 💀)
References: std::size()
🎀 find() — locating a C substring
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 the position of a C substring. Very demure, very _CharT *. ✨
Parameters:
__s— C string to locate.__pos— index of the character to search from.__n— number of characters fromsto search for.
Returns: index of the start of the first occurrence.
Starting from __pos, it searches forward for the first __n characters in __s within this string. If found, you get the index where it begins. If not found, npos. 🌈
References: std::data(), std::size()
Referenced by:
std::basic_string< _CharT, _Traits, _Alloc >::find()std::basic_string< _CharT, _Traits, _Alloc >::find()std::basic_string< _CharT, _Traits, _Alloc >::find()std::basic_string< _CharT, _Traits, _Alloc >::find_first_of()
🌟 find() — locating a whole C string
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], [noexcept]Find the position of a C string. The whole thing, no substring slicing. 🫶
Parameters:
__s— C string to locate.__pos— index of the character to search from (default0).
Returns: index of the start of the first occurrence.
Starting from __pos, it searches forward for the value of __s within this string. Found it? You get the index where it begins. Didn't find it? npos, bestie. 😭
References: std::basic_string< _CharT, _Traits, _Alloc >::find()
🧚 find() — the string_view-convertible version
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 [inline], [noexcept]Find the position of a string_view. Very modern of her, honestly obsessed. 💅
Parameters:
__svt— the object convertible tostring_viewto locate.__pos— index of the character to search from (default0).
Returns: index of the start of the first occurrence.
References: std::basic_string< _CharT, _Traits, _Alloc >::find()
💜 find() — the full basic_string version (the classic)
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 the position of a string. The OG. The main event. 👑
Parameters:
__str— string to locate.__pos— index of the character to search from (default0).
Returns: index of the start of the first occurrence.
Starting from __pos, it searches forward for the value of __str within this string. If found, you get the index where it begins. If not found, npos. 🍓
References: std::basic_string< _CharT, _Traits, _Alloc >::data(), std::basic_string< _CharT, _Traits, _Alloc >::find(), std::basic_string< _CharT, _Traits, _Alloc >::size()
🦋 find_first_not_of() — the character with "not like the others" energy
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 the position of a different character. The one that refused to match the group chat. 💀
Parameters:
__c— character to avoid.__pos— index of the character to search from (default0).
Returns: index of the first occurrence.
Starting from __pos, it searches forward for a character other than __c within this string. If found, you get the index where it was found. If not found, npos. 😭
References: std::size()
🌸 find_first_not_of() — the C substring version
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 the position of a character not in a C substring. Niche? Maybe. Iconic? Absolutely. ✨
Parameters:
__s— C string containing characters to avoid.__pos— index of the character to search from.__n— number of characters from__sto consider.
Returns: index of the first occurrence.
Starting from __pos, it searches forward for a character not contained in the first __n characters of __s within this string. If found, you get the index where it was found. If not found — npos, as always. 🫶
References: std::size()
🎀 find_first_not_of() — the C string version
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], [noexcept]Find the position of a character not in a C string. Same vibe, whole string, no __n shenanigans. 💅
Parameters:
__s— C string containing characters to avoid.__pos— index of the character to search from (default0).
Returns: index of the first occurrence.
Starting from __pos, it searches forward for a character not contained in __s within this string. If found, you get the index where it was found. If not found, npos. 🌈
References: std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of()
🌟 find_first_not_of() — the string_view-convertible version
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 [inline], [noexcept]Find the position of a character not in a string_view. The most spoiled-for-choice overload of the bunch, and she deserves it. 👑
Parameters:
__svt— an object convertible tostring_viewcontaining characters to avoid.__pos— index of the character to search from (default0).
Returns: index of the first occurrence.
References: std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of()
🌸 find_first_not_of — the string-flavored one
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. Like, where’s the first little icon that isn’t part of the squad?
- Parameters
__str— String containing characters to avoid.__pos— Index of character to search from (default0).
- 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.
- References
std::basic_string< _CharT, _Traits, _Alloc >::data(),std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of(), andstd::basic_string< _CharT, _Traits, _Alloc >::size(). - Referenced by
std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of(),std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of(), andstd::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of().
🔍 find_first_of — single character edition
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. One specific character. Main character energy, but make it a _CharT.
- Parameters
__c— Character to locate.__pos— Index of character to search from (default0).
- 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).
- References
std::basic_string< _CharT, _Traits, _Alloc >::find().
🎀 find_first_of — C substring edition
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. You’re giving it a C-style string and a character count, bestie. Very “here’s exactly how much of this thing to look at.”
- Parameters
__s— String containing characters to locate.__pos— Index of character to search from.__n— Number of characters fromsto 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.
- References
std::size().
🦋 find_first_of — C string edition
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], [noexcept]Find position of a character of C string. Same quest, but the C string runs the whole group chat.
- Parameters
__s— String containing characters to locate.__pos— Index of character to search from (default0).
- 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.
- References
std::basic_string< _CharT, _Traits, _Alloc >::find_first_of().
🌈 find_first_of — string_view-ish edition
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 [inline], [noexcept]Find position of a character of a string_view. It’s giving “I accept anything convertible to string_view, and I’m not sorry.”
- Parameters
__svt— An object convertible tostring_viewcontaining characters to locate.__pos— Index of character to search from (default0).
- Returns — Index of first occurrence.
- References
std::basic_string< _CharT, _Traits, _Alloc >::find_first_of().
🫶 find_first_of — string edition
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. Now the characters to locate are coming from another basic_string, which is lowkey the classic bestie move.
- Parameters
__str— String containing characters to locate.__pos— Index of character to search from (default0).
- 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.
- References
std::basic_string< _CharT, _Traits, _Alloc >::data(),std::basic_string< _CharT, _Traits, _Alloc >::find_first_of(), andstd::basic_string< _CharT, _Traits, _Alloc >::size(). - Referenced by
std::basic_string< _CharT, _Traits, _Alloc >::find_first_of(),std::basic_string< _CharT, _Traits, _Alloc >::find_first_of(), andstd::basic_string< _CharT, _Traits, _Alloc >::find_first_of().
💅 find_last_not_of — single character edition
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. It’s the “not like other characters” search, and it’s looking backward.
- Parameters
__c— Character to avoid.__pos— Index 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.
- References
std::size().
💀 find_last_not_of — C substring edition
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. Backward search, C-style string, and a limit on how many characters from s we’re considering. Very exact. Very mindful of boundaries.
- Parameters
__s— C string containing characters to avoid.__pos— Index of character to search back from.__n— Number of characters fromsto 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.
- References
std::size().
🙈 find_last_not_of — C string edition
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], [noexcept]Find last position of a character not in C string. The whole C string is invited to the “characters to avoid” party.
- Parameters
__s— C string containing characters to avoid.__pos— Index 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.
- References
std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of().
🧚 find_last_not_of — string_view-ish edition
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 [inline], [noexcept]Find last position of a character not in a string_view. Convertible-to-string_view object? Accepted. Searching backward? Obviously.
- Parameters
__svt— An object convertible tostring_viewcontaining characters to avoid.__pos— Index of character to search back from (default end).
- Returns — Index of last occurrence.
- References
std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of().
🍓 find_last_not_of — string edition
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. The avoid-list is another basic_string, and we’re going backward like we’re scrolling to the beginning of the timeline.
- Parameters
__str— String containing characters to avoid.__pos— Index 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.
- References
std::basic_string< _CharT, _Traits, _Alloc >::data(),std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of(), andstd::basic_string< _CharT, _Traits, _Alloc >::size(). - Referenced by
std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of(),std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of(), andstd::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of().
👑 find_last_of — single character edition
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. One character. Last appearance. Scrolling backward with intention.
- Parameters
__c— Character to locate.__pos— Index 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).
- References
std::basic_string< _CharT, _Traits, _Alloc >::rfind().
⭐ find_last_of — C substring edition
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. You’ve got a C string, a starting point, and a count of characters from s to search for. The group chat is limited, but the search is still real.
- Parameters
__s— C string containing characters to locate.__pos— Index of character to search back from.__n— Number of characters fromsto 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.
- References
std::size().
🌟 find_last_of — C string edition
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], [noexcept]Find last position of a character of C string. Whole C string, last matching character, no count needed. We love a simple ask.
- Parameters
__s— C string containing characters to locate.__pos— Index 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.
- References
std::basic_string< _CharT, _Traits, _Alloc >::find_last_of().
🎀 find_last_of — string_view-ish edition
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 [inline], [noexcept]Find last position of a character of string.
Parameters
__svt— an object that converts tostring_view, holding the characters you're hunting for 🕵️♀️__pos— the index of the character to search back from (defaults to the end, bestie)
Returns
The index of the last occurrence 💖
References std::basic_string< _CharT, _Traits, _Alloc >::find_last_of().
find_last_of — the basic_string flavor 🎀
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]Okay so this one literally finds the last position of any character from a string, no cap.
Parameters
__str— the string containing the characters to locate__pos— the index of the character to search back from (default is the end)
Returns
The index of the last occurrence ✨
So here's the vibe: starting from __pos, it searches backward for one of the characters of __str inside this string. If it finds one, it hands you the index where it was found. If it doesn't? npos. That's it, that's the whole story 😭
References std::basic_string< _CharT, _Traits, _Alloc >::data(), std::basic_string< _CharT, _Traits, _Alloc >::find_last_of(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
Also referenced by std::basic_string< _CharT, _Traits, _Alloc >::find_last_of(), std::basic_string< _CharT, _Traits, _Alloc >::find_last_of(), and std::basic_string< _CharT, _Traits, _Alloc >::find_last_of(). (Yes, she references herself. Main character energy, honestly 👑)
front — read/write edition 🌸
template<typename _CharT , typename _Traits , typename _Alloc > reference
std::basic_string< _CharT, _Traits, _Alloc >::front () [inline]Gives you a read/write reference to the data sitting at the very first element of the string. First one up, front of the line, main character of the string 💅
References std::basic_string< _CharT, _Traits, _Alloc >::empty(), and std::basic_string< _CharT, _Traits, _Alloc >::operator[]().
front — const edition 🦋
template<typename _CharT , typename _Traits , typename _Alloc >
const_reference std::basic_string< _CharT, _Traits, _Alloc >::front ()
const [inline], [noexcept]Same first element, but read-only. Look, don't touch 👀 She's giving constant reference, literally.
References std::basic_string< _CharT, _Traits, _Alloc >::empty(), and std::basic_string< _CharT, _Traits, _Alloc >::operator[]().
get_allocator 🧚
template<typename _CharT , typename _Traits , typename _Alloc >
allocator_type std::basic_string< _CharT, _Traits, _Alloc
>::get_allocator () const [inline], [noexcept]Returns a copy of the allocator that was used to construct this string. Like, the receipts of who built this thing 🎀
Referenced by std::basic_string< _CharT, _Traits, _Alloc >::~basic_string(), std::basic_string< _CharT, _Traits, _Alloc >::assign(), std::basic_string< _CharT, _Traits, _Alloc >::clear(), and std::basic_stringbuf< _CharT, _Traits, _Alloc >::str().
✨ the insert era ✨ (yes there are SO many, buckle up)
insert — one single character 🍓
template<typename _CharT , typename _Traits , typename _Alloc > iterator
std::basic_string< _CharT, _Traits, _Alloc >::insert (iterator __p,
_CharT __c) [inline]Insert one character. One. Singular. Iconic.
Parameters
__p— an iterator referencing the position in the string to insert at__c— the character to insert
Returns
An iterator referencing the newly inserted char 💖
Exceptions
std::length_error— if the new length exceedsmax_size()
Inserts character __c at the position referenced by __p. If adding the character makes the length exceed max_size(), length_error gets thrown. If __p is beyond the end of the string, out_of_range gets thrown. And the string's value doesn't change if an error is thrown — no half-finished chaos, we love a clean rollback 🙌
insert — a whole range of characters 🌈
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. A whole squad, not just one 💅
Parameters
__p— an iterator referencing the location in the string to insert at__beg— start of the range__end— end of the range
Exceptions
std::length_error— if the new length exceedsmax_size()
Inserts the characters in the range [__beg,__end). If adding those characters makes the length exceed max_size(), length_error gets thrown. The value of the string doesn't change if an error is thrown. Periodt.
References std::basic_string< _CharT, _Traits, _Alloc >::replace().
insert — an initializer_list 🎀
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. Very curly-braces of her ✨
Parameters
__p— an iterator referencing the location in the string to insert at__l— theinitializer_listof characters to insert
Exceptions
std::length_error— if the new length exceedsmax_size()
References std::basic_string< _CharT, _Traits, _Alloc >::insert().
insert — multiple copies of one char, at an iterator 🦋
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. Same char, __n times, we're spamming it on purpose 🫶
Parameters
__p— an iterator referencing the location in the string to insert at__n— number of characters to insert__c— the character to insert
Exceptions
std::length_error— if the new length exceedsmax_size()
Inserts __n copies of character __c starting at the position referenced by iterator __p. If adding characters makes the length exceed max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.
References std::basic_string< _CharT, _Traits, _Alloc >::replace().
Referenced by std::basic_string< _CharT, _Traits, _Alloc >::insert(), std::basic_string< _CharT, _Traits, _Alloc >::insert(), std::basic_string< _CharT, _Traits, _Alloc >::insert(), std::basic_string< _CharT, _Traits, _Alloc >::insert(), and std::basic_string< _CharT, _Traits, _Alloc >::insert(). (Five of them. FIVE. She's popular 💀)
insert — a C string 🌿
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. Retro, but it ate.
Parameters
__pos— position in the string to insert at__s— the C string to insert
Returns
A reference to this string 💜
Exceptions
std::length_error— if the new length exceedsmax_size()std::out_of_range— if pos is beyond the end of this string
Inserts the first n characters of __s starting at __pos. If adding characters makes the length 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.
References std::basic_string< _CharT, _Traits, _Alloc >::insert().
insert — a C substring 🌸
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 — now with a length limit, because we're being responsible 💅
Parameters
__pos— position in the string to insert at__s— the C string to insert__n— the number of characters to insert
Returns
A reference to this string 💜
Exceptions
std::length_error— if the new length exceedsmax_size()std::out_of_range— if__posis beyond the end of this string
Inserts the first __n characters of __s starting at __pos. If adding characters makes the length 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.
insert — a string_view convertible situation 🧚
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. Modern. Chic. Obsessed.
Parameters
__pos— position in the string to insert at__svt— the object convertible tostring_viewto insert
Returns
A reference to this string 💜
References std::basic_string< _CharT, _Traits, _Alloc >::insert().
insert — multiple chars at an index 🔥
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. Same energy as before, but indexed instead of iterator'd 🎀
Parameters
__pos— index in the string to insert at__n— number of characters to insert__c— the character to insert
Returns
A reference to this string 💜
Exceptions
std::length_error— if the new length exceedsmax_size()std::out_of_range— if__posis beyond the end of this string
Inserts __n copies of character __c starting at index __pos. If adding characters makes the length 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.
insert — string_view, but slice it first ✂️
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. But this time — and hear me out — we're taking a slice of the string_view first. Double positioning, double iconic 💖
Parameters
__pos1— position in the string to insert at__svt— the object convertible tostring_viewto insert from__pos2— position in thestring_viewto insert from__n— the number of characters to insert
Returns
A reference to this string 💜
References std::basic_string< _CharT, _Traits, _Alloc >::replace().
insert — the value of a whole string 👑
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 the value of a string. String-ception, and she's serving.
Parameters
__pos1— position in the string to insert at__str— the string to insert
Returns
A reference to this string 💜
Exceptions
std::length_error— if the new length exceedsmax_size()
Inserts the value of __str starting at __pos1. If adding characters makes the length exceed max_size(), length_error is thrown. The value of the string doesn't change if an error is thrown.
References std::basic_string< _CharT, _Traits, _Alloc >::insert(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
insert — a substring of a string, the final boss 🫶
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. Four parameters. She said "go big or go home" 💀
Parameters
__pos1— position in the string to insert at__str— the string to insert__pos2— start of characters in str to insert__n— number of characters to insert
Returns
A reference to this string 💜
Exceptions
std::length_error— if the new length exceedsmax_size()std::out_of_range— if pos1 > size() or__pos2> str.size()
Starting at pos1, insert __n characters of __str beginning with __pos2. If adding characters makes the length 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.
ngl the "value doesn't change if an error is thrown" guarantee showing up on every single overload is lowkey the most reassuring thing in this whole page. Strong exception safety? We stan a reliable queen 💅✨
🌸 length () — how many chars tho
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 💅. That's the whole personality of this one.
References std::basic_string< _CharT, _Traits, _Alloc >::size().
Referenced by std::collate< _CharT >::do_compare(), std::collate< _CharT >::do_transform(), std::regex_traits< _Ch_type >::length(), and std::regex_replace().
📏 max_size () — the ceiling, bestie
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. Like, the absolute ceiling. The final boss of lengths 🏔️.
Referenced by std::getline(), and std::operator>>().
🦋 operator __sv_type () — the glow-up into a string_view
template<typename _CharT , typename _Traits , typename _Alloc >
std::basic_string< _CharT, _Traits, _Alloc >::operator __sv_type () const [inline], [noexcept]Convert to a string_view. Lowkey iconic conversion behavior ✨.
Returns
- A
string_view.
References std::basic_string< _CharT, _Traits, _Alloc >::data(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
➕ operator+= (_CharT __c) — append one lil char
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string &
std::basic_string< _CharT, _Traits, _Alloc >::operator+= (_CharT __c) [inline]Append a character. Just the one. A single little guy 🎀.
Parameters
__c— The character to append.
Returns
- Reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::push_back().
➕ operator+= (const _CharT * __s) — append a C string
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string &
std::basic_string< _CharT, _Traits, _Alloc >::operator+= (const _CharT * __s) [inline]Append a C string. Yes, the old-school null-terminated kind, she still serves 🫶.
Parameters
__s— The C string to append.
Returns
- Reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::append().
➕ operator+= (const _Tp & __svt) — append a string_view
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. Note the _If_sv< _Tp, basic_string & > guard — it only kicks in when the type is actually convertible, iykyk 💜.
Parameters
__svt— The object convertible tostring_viewto be appended.
Returns
- Reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::append().
➕ operator+= (const basic_string & __str) — append a whole string
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. String-on-string. Grown-folk business 🌈.
Parameters
__str— The string to append.
Returns
- Reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::append().
➕ operator+= (initializer_list< _CharT > __l) — append a brace-ful of chars
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. Very { 'a', 'b' } of it 💅.
Parameters
__l— Theinitializer_listof characters to be appended.
Returns
- Reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::append().
✍️ operator= (_CharT __c) — become one character
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string &
std::basic_string< _CharT, _Traits, _Alloc >::operator= (_CharT __c) [inline]Set value to a string of length 1. Main character energy, literally one of her 😭.
Parameters
__c— Source character.
Assigning to a character makes this string length 1 and (*this)[0] == c.
References std::basic_string< _CharT, _Traits, _Alloc >::assign().
🚚 operator= (basic_string< _CharT, _Traits, _Alloc > && __str) — move-assign, no copies
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string &
std::basic_string< _CharT, _Traits, _Alloc >::operator= (basic_string< _CharT, _Traits, _Alloc > && __str) [inline], [noexcept]Move assign the value of str to this string.
Parameters
__str— Source string.
The contents of str are moved into this string (without copying). str is a valid, but unspecified string. So like, she's still alive and legal to touch, but don't go assuming what's in her after the move 🙈.
References std::basic_string< _CharT, _Traits, _Alloc >::swap().
✍️ operator= (const _CharT * __s) — copy in a C string
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
__s— Source null-terminated string.
References std::basic_string< _CharT, _Traits, _Alloc >::assign().
✍️ operator= (const _Tp & __svt) — assign from a string_view
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 a string constructed from a string_view.
Parameters
__svt— An object convertible tostring_view.
References std::basic_string< _CharT, _Traits, _Alloc >::assign().
✍️ operator= (const basic_string< _CharT, _Traits, _Alloc > & __str) — copy-assign
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
__str— Source string.
References std::basic_string< _CharT, _Traits, _Alloc >::assign().
✍️ operator= (initializer_list< _CharT > __l) — assign from a brace list
template<typename _CharT , typename _Traits , typename _Alloc >
basic_string &
std::basic_string< _CharT, _Traits, _Alloc >::operator= (initializer_list< _CharT > __l) [inline]Set value to a string constructed from an initializer list.
Parameters
__l—std::initializer_list.
References std::basic_string< _CharT, _Traits, _Alloc >::assign().
🔎 operator[] (size_type __pos) — the read/write subscript
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. Array-style, iconic, timeless 👑.
Parameters
__pos— The 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.
⚠️ Okay bestie, read this twice: unchecked. Out-of-range is undefined behavior, not a cute little exception. If you're not 100% sure__posis valid, useat()and stop playing with fire 💀🔥
References std::basic_string< _CharT, _Traits, _Alloc >::size().
🔍 operator[] (size_type __pos) const — the read-only subscript
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, but make it const ✨.
Parameters
__pos— The 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().)
⚠️ Same warning, same drama — unchecked and undefined out-of-range behavior. The const version doesn't unshare the string, but it will absolutely not save you from a bad index 🙈
References std::basic_string< _CharT, _Traits, _Alloc >::size().
Referenced by std::basic_string< _CharT, _Traits, _Alloc >::back(), std::basic_string< _CharT, _Traits, _Alloc >::back(), std::basic_string< _CharT, _Traits, _Alloc >::front(), and std::basic_string< _CharT, _Traits, _Alloc >::front().
🗑️ pop_back () — bye-bye last char
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. Like, she can't lose a char she doesn't have, so vibe-check with empty() first 😭.
References std::basic_string< _CharT, _Traits, _Alloc >::empty(), std::basic_string< _CharT, _Traits, _Alloc >::erase(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
📥 push_back (_CharT __c) — bestie incoming
template<typename _CharT , typename _Traits , typename _Alloc >
void
std::basic_string< _CharT, _Traits, _Alloc >::push_back (_CharT __c) [inline]Append a single character. One char, one queen, one addition to the roster 🎀.
Parameters
__c— Character to append.
References std::basic_string< _CharT, _Traits, _Alloc >::capacity(), std::basic_string< _CharT, _Traits, _Alloc >::reserve(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
Referenced by std::collate< _CharT >::do_transform(), std::basic_string< _CharT, _Traits, _Alloc >::operator+=(), std::tr2::operator>>(), and std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow().
⏪ rbegin () — reverse iterator, read/write
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 — so she starts at the end and walks backward, which is honestly so her 💅. Unshares the string.
References std::basic_string< _CharT, _Traits, _Alloc >::end().
⏪ rbegin () const — reverse iterator, read-only
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.
References std::basic_string< _CharT, _Traits, _Alloc >::end().
⏩ rend () — reverse end, read/write
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.
References std::basic_string< _CharT, _Traits, _Alloc >::begin().
⏩ rend () const — reverse end, read-only
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.
References std::basic_string< _CharT, _Traits, _Alloc >::begin().
🔁 replace (const_iterator __i1, const_iterator __i2, const _Tp & __svt) — swap a range for a string_view
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 a range of characters with a string_view. Out with the old, in with the view ✨.
Parameters
__i1— An iterator referencing the start position to replace at.__i2— An iterator referencing the end position for the replace.__svt— The object convertible tostring_viewto insert from.
Returns
- Reference to this string.
References std::basic_string< _CharT, _Traits, _Alloc >::begin(), and std::basic_string< _CharT, _Traits, _Alloc >::replace().
🔁 replace (iterator __i1, iterator __i2, _InputIterator __k1, _InputIterator __k2) — swap a range for a range
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 a range of characters with a range. Two iterator pairs, one glow-up 🦋.
Parameters
__i1— Iterator referencing start of range to replace.__i2— Iterator referencing end of range to replace.__k1— Iterator referencing start of range to insert.__k2— Iterator referencing end of range to insert.
Returns
- Reference to this string.
Exceptions
std::length_error— If new length exceedsmax_size().
💀 Heads up: blow pastmax_size()and she throwsstd::length_error. Respect the ceiling, fr fr.
...okay so picking up right where we left off: it removes the characters in the range [__i1,__i2), and in place of them, the characters in the range [__k1,__k2) get inserted. ✨ If the length of the result exceeds max_size(), length_error is thrown. And the bestie-safe part? The value of the string doesn't change if an error is thrown. 🫶
💅 replace() — replace a range with a C string
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
__i1— Iterator referencing start of range to replace.__i2— Iterator referencing end of range to replace.__s— C string value to insert.
Returns
Reference to this string.
Exceptions
std::length_error— If new length exceedsmax_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. 💀
References: std::basic_string< _CharT, _Traits, _Alloc >::replace().
🦋 replace() — replace a range with a C substring
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
__i1— Iterator referencing start of range to replace.__i2— Iterator referencing end of range to replace.__s— C string value to insert.__n— Number of characters fromsto insert.
Returns
Reference to this string.
Exceptions
std::length_error— If new length exceedsmax_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. 🌸
References: std::basic_string< _CharT, _Traits, _Alloc >::replace().
💖 replace() — replace a range with a whole other string
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
__i1— Iterator referencing start of range to replace.__i2— Iterator referencing end of range to replace.__str— String value to insert.
Returns
Reference to this string.
Exceptions
std::length_error— If new length exceedsmax_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. 🎀
References: std::basic_string< _CharT, _Traits, _Alloc >::replace(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
🌈 replace() — replace a range with an initializer_list
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
__i1— Iterator referencing start of range to replace.__i2— Iterator referencing end of range to replace.__l— Theinitializer_listof characters to insert.
Returns
Reference to this string.
Exceptions
std::length_error— If new length exceedsmax_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. 💅
References: std::basic_string< _CharT, _Traits, _Alloc >::replace().
💜 replace() — replace a range with n copies of a char
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. 😭 (in a good way)
Parameters
__i1— Iterator referencing start of range to replace.__i2— Iterator referencing end of range to replace.__n— Number of characters to insert.__c— Character to insert.
Returns
Reference to this string.
Exceptions
std::length_error— If new length exceedsmax_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. ✨
🧚 replace() — replace a range with a string_view-ish thing
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
__pos— The position to replace at.__n— The number of characters to replace.__svt— The object convertible tostring_viewto insert.
Returns
Reference to this string.
References: std::basic_string< _CharT, _Traits, _Alloc >::replace().
👑 replace() — replace characters with the value of another string
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
__pos— Index of first character to replace.__n— Number of characters to be replaced.__str— String to insert.
Returns
Reference to this string.
Exceptions
std::out_of_range— Ifposis beyond the end of this string.std::length_error— If new length exceedsmax_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. 🔥
References: std::basic_string< _CharT, _Traits, _Alloc >::replace(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
Referenced by — and bestie, the repeats are not a typo, there are genuinely that many overloads fr fr 💀:
std::basic_string< _CharT, _Traits, _Alloc >::append()std::basic_string< _CharT, _Traits, _Alloc >::assign()std::basic_string< _CharT, _Traits, _Alloc >::insert()std::basic_string< _CharT, _Traits, _Alloc >::insert()std::basic_string< _CharT, _Traits, _Alloc >::insert()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()
🎀 replace() — replace characters with the value of a C string
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
__pos— Index of first character to replace.__n1— Number of characters to be replaced.__s— C string to insert.
Returns
Reference to this string.
Exceptions
std::out_of_range— Ifpos > size().std::length_error— If new length exceedsmax_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. 💫
References: std::basic_string< _CharT, _Traits, _Alloc >::replace().
⭐ replace() — replace characters with the value of a C substring
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
__pos— Index of first character to replace.__n1— Number of characters to be replaced.__s— C string to insert.__n2— Number of characters fromsto use.
Returns
Reference to this string.
Exceptions
std::out_of_range— Ifpos1 > size().std::length_error— If new length exceedsmax_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. 🫶
🔥 replace() — replace characters with multiple characters
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
__pos— Index of first character to replace.__n1— Number of characters to be replaced.__n2— Number of characters to insert.__c— Character to insert.
Returns
Reference to this string.
Exceptions
std::out_of_range— If__pos > size().std::length_error— If new length exceedsmax_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. 💀
🧚♀️ replace() — replace a range with a slice of a string_view-ish thing
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
__pos1— The position to replace at.__n1— The number of characters to replace.__svt— The object convertible tostring_viewto insert from.__pos2— The position in thestring_viewto insert from.__n2— The number of characters to insert. (defaults tonpos, iykyk ✨)
Returns
Reference to this string.
References: std::basic_string< _CharT, _Traits, _Alloc >::replace().
✨ replace — the "swap in someone else's glow" move 💅
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]Okay so this overload is the five-parameter replace serve, and it is lowkey surgical, bestie. It swaps a chunk of this string for a chunk of another string. No cap.
Parameters:
__pos1— index of first character to replace. Like the start of the makeover zone.__n1— number of characters to be replaced. How many are getting evicted.__str— string to insert. The incoming icon.__pos2— index of first character ofstrto use. Where we start copying from__str.__n2— number of characters fromstrto use.
Returns: Reference to this string. Chaining rights? periodt.
Exceptions:
std::out_of_range— if__pos1 > size()or__pos2 > __str.size().std::length_error— if new length exceedsmax_size().
It 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. Safety behavior! We love a no-corruption moment.
References: std::basic_string< _CharT, _Traits, _Alloc >::replace().
🌸 reserve() — the no-arg version, yes really 🎀
template<typename _CharT , typename _Traits , typename _Alloc > void std::basic_string< _CharT, _Traits, _Alloc >::reserve ()Equivalent to shrink_to_fit(). That's it. Tiny function, big "okay werk" energy. ✨
Referenced by: std::basic_string< _CharT, _Traits, _Alloc >::push_back(), and std::basic_string< _CharT, _Traits, _Alloc >::shrink_to_fit().
🦋 reserve(size_type __res_arg) — preallocating the vibe ✨
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. We stan planning ahead, honestly.
Parameters:
__res_arg— number of characters required.
Exceptions:
std::length_error— if__res_argexceedsmax_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. Prevent reallocation. Prevent copying. Main character optimization energy.
References: std::size().
Referenced by: std::num_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(), std::tr2::operator>>(), and std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow().
🎀 resize(size_type __n) — truncate or extend, no drama 💖
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:
__n— number 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. Default-constructed chars are just lil zeroes, iykyk.
References: std::basic_string< _CharT, _Traits, _Alloc >::resize().
🍓 resize(size_type __n, _CharT __c) — extend with your fave char 🌸
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:
__n— number of characters the string should contain.__c— character 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. Fill char? Iconic behavior.
References: std::size().
Referenced by: std::money_get< _CharT, _InIter >::do_get(), and std::basic_string< _CharT, _Traits, _Alloc >::resize().
🔥 rfind(_CharT __c, size_type __pos = npos) — searching backward, main character energy 👑
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:
__c— character to locate.__pos— index 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. Backward search? She's looking back, but make it fashion.
References: std::size().
👑 rfind(const _CharT * __s, size_type __pos, size_type __n) — last C substring moment 🌈
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:
__s— C string to locate.__pos— index of character to search back from.__n— number 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. First __n chars only. We're being specific.
References: std::min(), and std::size().
🌈 rfind(const _CharT * __s, size_type __pos = npos) — C string, last call 🦋
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], [noexcept]Find last position of a C string.
Parameters:
__s— C string to locate.__pos— index 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. If not found? npos. The eternal "no bestie" answer.
References: std::basic_string< _CharT, _Traits, _Alloc >::rfind().
🧚 rfind(const _Tp & __svt, size_type __pos = npos) — string_view edition 💜
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 [inline], [noexcept]Find last position of a string_view.
Parameters:
__svt— the object convertible to string_view to locate.__pos— index of character to search back from (default end).
Returns: Index of start of last occurrence.
References: std::basic_string< _CharT, _Traits, _Alloc >::rfind().
💜 rfind(const basic_string& __str, size_type __pos = npos) — last position of a string 💅
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:
__str— string to locate.__pos— index 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.
References: std::basic_string< _CharT, _Traits, _Alloc >::data(), std::basic_string< _CharT, _Traits, _Alloc >::rfind(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
Referenced by:
std::basic_string< _CharT, _Traits, _Alloc >::find_last_of()std::basic_string< _CharT, _Traits, _Alloc >::rfind()std::basic_string< _CharT, _Traits, _Alloc >::rfind()std::basic_string< _CharT, _Traits, _Alloc >::rfind()
🌟 shrink_to_fit() — non-binding capacity request, no pressure 🫶
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(). Non-binding means it's a vibe request, not a demand. She may or may not listen.
References: std::basic_string< _CharT, _Traits, _Alloc >::reserve().
💅 size() — how many chars, no null terminator 🎀
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. Not including the null. She's not counting the invisible girl.
Referenced by:
std::tr2::dynamic_bitset< _WordT, _Alloc >::dynamic_bitset()std::basic_string< _CharT, _Traits, _Alloc >::append()std::basic_regex< _Ch_type, _Rx_traits >::assign()std::basic_string< _CharT, _Traits, _Alloc >::assign()std::basic_string< _CharT, _Traits, _Alloc >::at()std::basic_string< _CharT, _Traits, _Alloc >::at()std::basic_string< _CharT, _Traits, _Alloc >::back()std::basic_string< _CharT, _Traits, _Alloc >::back()std::basic_string< _CharT, _Traits, _Alloc >::cend()std::basic_string< _CharT, _Traits, _Alloc >::compare()std::basic_string< _CharT, _Traits, _Alloc >::compare()std::basic_string< _CharT, _Traits, _Alloc >::compare()std::basic_string< _CharT, _Traits, _Alloc >::compare()std::basic_string< _CharT, _Traits, _Alloc >::empty()std::basic_string< _CharT, _Traits, _Alloc >::end()std::basic_string< _CharT, _Traits, _Alloc >::end()std::basic_string< _CharT, _Traits, _Alloc >::find()std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of()std::basic_string< _CharT, _Traits, _Alloc >::find_first_of()std::basic_string< _CharT, _Traits, _Alloc >::find_last_not_of()std::basic_string< _CharT, _Traits, _Alloc >::find_last_of()std::match_results< _Bi_iter, _Alloc >::format()std::basic_string< _CharT, _Traits, _Alloc >::insert()std::basic_string< _CharT, _Traits, _Alloc >::length()std::basic_string< _CharT, _Traits, _Alloc >::operator __sv_type()std::tr2::operator>>()std::basic_string< _CharT, _Traits, _Alloc >::operator[]()std::basic_string< _CharT, _Traits, _Alloc >::operator[]()std::basic_string< _CharT, _Traits, _Alloc >::pop_back()std::basic_string< _CharT, _Traits, _Alloc >::push_back()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::replace()std::basic_string< _CharT, _Traits, _Alloc >::rfind()std::basic_stringbuf< _CharT, _Traits, _Alloc >::str()std::regex_traits< _Ch_type >::transform()
🌸 substr(size_type __pos = 0, size_type __n = npos) — get a substring, bestie 🦋
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. Clone it. Cut it. Serve it.
Parameters:
__pos— index of first character (default 0).__n— number of characters in substring (default remainder).
Returns: The new string.
Exceptions:
std::out_of_range— if__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. Beyond the end? Absolutely not. out_of_range says no.
References: std::basic_string< _CharT, _Traits, _Alloc >::basic_string().
🫶 swap(basic_string& __s) — swap contents with another string 💖
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:
__s— string to swap with.
okay so this next bit is literally the swap glow-up: it exchanges the contents of this string with that of __s in constant time 💅✨ — one lil’ handoff, no big-O drama. and bestie, it shows up in the receipts for std::basic_string< _CharT, _Traits, _Alloc >::assign(), and std::basic_string< _CharT, _Traits, _Alloc >::operator=() (iykyk, those two keep calling it).
Member Data Documentation 🎀
here’s the icon itself, copied exactly so nobody comes for me:
template<typename _CharT , typename _Traits , typename _Alloc > const
basic_string< _CharT, _Traits, _Alloc >::size_type std::basic_string<
_CharT, _Traits , _Alloc >::npos [static]that’s std::basic_string< _CharT, _Traits, _Alloc >::npos with the [static] badge 👑, and its whole personality is: the value returned by various member functions when they fail 😭💀. like, when a member function flops, this is the lil’ value it hands back — no cap, that’s the documented behavior.
Author ✨
generated automatically by Doxygen for libstdc++ from the source code. so yes, the docs are giving auto-generated main character energy — Doxygen pulled it straight from the libstdc++ source code, periodt 🫶.
and that’s the whole page, bestie — the footer’s got the libstdc++ version/date stamp on it, so peek at that generated footer for the exact source/version/date tea 💖🌈
📦 where this page comes from
- ubuntu noble: libstdc++-14-doc 14-20240412-0ubuntu1
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms