• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_static_string::erase (2 of 3 overloads)</title>
5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../../index.html" title="Boost.StaticString">
8<link rel="up" href="../erase.html" title="basic_static_string::erase">
9<link rel="prev" href="overload1.html" title="basic_static_string::erase (1 of 3 overloads)">
10<link rel="next" href="overload3.html" title="basic_static_string::erase (3 of 3 overloads)">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../erase.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2"></a><a class="link" href="overload2.html" title="basic_static_string::erase (2 of 3 overloads)">basic_static_string::erase
28          (2 of 3 overloads)</a>
29</h5></div></div></div>
30<p>
31            Erase from the string.
32          </p>
33<h6>
34<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.h0"></a>
35            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.synopsis"></a></span><a class="link" href="overload2.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload2.synopsis">Synopsis</a>
36          </h6>
37<pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">iterator</span>
38<span class="identifier">erase</span><span class="special">(</span>
39    <span class="identifier">const_iterator</span> <span class="identifier">pos</span><span class="special">);</span>
40</pre>
41<h6>
42<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.h1"></a>
43            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.description"></a></span><a class="link" href="overload2.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload2.description">Description</a>
44          </h6>
45<p>
46            Erases the character at <code class="computeroutput"><span class="identifier">pos</span></code>.
47          </p>
48<h6>
49<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.h2"></a>
50            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.preconditions"></a></span><a class="link" href="overload2.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload2.preconditions">Preconditions</a>
51          </h6>
52<p>
53            <code class="computeroutput"><span class="identifier">pos</span></code>shall be valid within
54            {<a class="link" href="../data/overload1.html" title="basic_static_string::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code></a>,
55            <a class="link" href="../data/overload1.html" title="basic_static_string::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code></a>
56            + <a class="link" href="../size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a>}
57          </p>
58<h6>
59<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.h3"></a>
60            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.exception_safety"></a></span><a class="link" href="overload2.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload2.exception_safety">Exception
61            Safety</a>
62          </h6>
63<p>
64            Strong guarantee.
65          </p>
66<h6>
67<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.h4"></a>
68            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.remarks"></a></span><a class="link" href="overload2.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload2.remarks">Remarks</a>
69          </h6>
70<p>
71            All references, pointers, or iterators referring to contained elements
72            are invalidated. Any past-the-end iterators are also invalidated.
73          </p>
74<h6>
75<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.h5"></a>
76            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.return_value"></a></span><a class="link" href="overload2.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload2.return_value">Return
77            Value</a>
78          </h6>
79<p>
80            An iterator referring to character immediately following the erased character,
81            or <a class="link" href="../end/overload1.html" title="basic_static_string::end (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">end</span><span class="special">()</span></code></a>
82            if one does not exist.
83          </p>
84<h6>
85<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.h6"></a>
86            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload2.parameters"></a></span><a class="link" href="overload2.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload2.parameters">Parameters</a>
87          </h6>
88<div class="informaltable"><table class="table">
89<colgroup>
90<col>
91<col>
92</colgroup>
93<thead><tr>
94<th>
95                    <p>
96                      Name
97                    </p>
98                  </th>
99<th>
100                    <p>
101                      Description
102                    </p>
103                  </th>
104</tr></thead>
105<tbody><tr>
106<td>
107                    <p>
108                      <code class="computeroutput"><span class="identifier">pos</span></code>
109                    </p>
110                  </td>
111<td>
112                    <p>
113                      An iterator referring to the character to erase.
114                    </p>
115                  </td>
116</tr></tbody>
117</table></div>
118</div>
119<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
120<td align="left"></td>
121<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie
122      Falco<p>
123        Distributed under the Boost Software License, Version 1.0. (See accompanying
124        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
125      </p>
126</div></td>
127</tr></table>
128<hr>
129<div class="spirit-nav">
130<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../erase.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
131</div>
132</body>
133</html>
134