std::basic_string<CharT,Traits,Allocator>::begin, (3) - Linux Manuals

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

NAME

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

Synopsis

iterator begin();                               (until C++11)
iterator begin() noexcept;                      (since C++11)
const_iterator begin() const;           (1)                   (until C++11)
const_iterator begin() const noexcept;      (2)               (since C++11)
const_iterator cbegin() const noexcept;         (3)           (since C++11)

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

Parameters

(none)

Return value

iterator to the first character

Complexity

Constant

Example

// Run this code

 #include <string>
 #include <iostream>

 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