std::basic_string::end,(3)

okay bestie, this is std::basic_string::end,(3) from the C++ Standard Libary manual, and it's literally the page for std::basic_string's end/cend situation 💖 no cap.

🎀 NAME 🎀

std::basic_string::end, - std::basic_string::end,

yes, that's the NAME line verbatim, comma chaos and all — she's a little quirky but iconic 💅

🌸 Synopsis 🌸

iterator end();                       (1) (noexcept since C++11)
                                          (constexpr since C++20)
const_iterator end() const;           (2) (noexcept since C++11)
                                          (constexpr since C++20)
const_iterator cend() const noexcept; (3) (since C++11)
                                          (constexpr since C++20)

Okay so this returns an iterator to the character following the last character of the string. That character acts as a placeholder, and bestie, attempting to access it results in undefined behavior 😭 — like, do not mess with the placeholder, fr fr.

The original page also has range-begin-end.svg chilling right here — iconic filename moment 🌈.

🙈 Parameters 🙈

(none) — not a single parameter, zero, nada, the void 💀.

⭐ Return value ⭐

Iterator to the character following the last character. That's the whole return value, and it ate 💅.

🔥 Complexity 🔥

Constant. That's it. Constant. periodt ⭐.

💜 Notes 💜

libc++ backports cend() to C++98 mode. — that's the note, and it's lowkey a C++98 backport moment 🫶.

💻 Example 💻

The original says // Run this code, so here's the code verbatim, bestie:

#include <algorithm>
#include <iostream>
#include <iterator>
#include <string>

int main()
{
    std::string s("Exemparl");
    std::next_permutation(s.begin(), s.end());

    std::string c;
    std::copy(s.cbegin(), s.cend(), std::back_inserter(c));
    std::cout << c << '\n'; // "Exemplar"
}

🍓 Output: 🍓

Exemplar

🦋 See also 🦋

• begin — returns an iterator to the beginning
• cbegin — (public member function) (C++11)
• end — returns an iterator to the end
• cend — (public member function of std::basic_string_view<CharT,Traits>)

mwah 💋 — source/version and date: http://cppreference.com · 2024.06.10 🌸