Namespaces
Variants
Views
Actions

std::basic_string<CharT,Traits,Allocator>::begin, std::basic_string<CharT,Traits,Allocator>::cbegin

From cppreference.com
< cpp‎ | string‎ | basic string
 
 
 
std::basic_string
Member functions
Element access
Iterators
basic_string::beginbasic_string::cbegin
(C++11)
Capacity
Modifiers
Search
Operations
Constants
Deduction guides (C++17)
Non-member functions
I/O
Comparison
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)
Numeric conversion
(C++11)(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Helper classes
 
(1)
iterator begin();
(until C++11)
iterator begin() noexcept;
(since C++11)
(until C++20)
constexpr iterator begin() noexcept;
(since C++20)
(2)
const_iterator begin() const;
(until C++11)
const_iterator begin() const noexcept;
(since C++11)
(until C++20)
constexpr const_iterator begin() const noexcept;
(since C++20)
(3)
const_iterator cbegin() const noexcept;
(since C++11)
(until C++20)
constexpr const_iterator cbegin() const noexcept;
(since C++20)

Returns an iterator to the first character of the string.

begin() returns a mutable or constant iterator, depending on the constness of *this.

cbegin() always returns a constant iterator. It is equivalent to const_cast<const basic_string&>(*this).begin().

range-begin-end.svg

Contents

[edit] Parameters

(none)

[edit] Return value

Iterator to the first character.

[edit] Complexity

Constant.

[edit] Notes

libc++ backports cbegin() to C++98 mode.

[edit] Example

#include <iostream>
#include <string>
 
int main()
{
    std::string s("Exemplar");
    *s.begin() = 'e';
    std::cout << s << '\n';
 
    auto i = s.cbegin();
    std::cout << *i << '\n';
//  *i = 'E'; // error: i is a constant iterator
}

Output:

exemplar
e

[edit] See also

(C++11)
returns an iterator to the end
(public member function) [edit]
returns an iterator to the beginning
(public member function of std::basic_string_view<CharT,Traits>) [edit]