• 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::replace (12 of 14 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="../replace.html" title="basic_static_string::replace">
9<link rel="prev" href="overload11.html" title="basic_static_string::replace (11 of 14 overloads)">
10<link rel="next" href="overload13.html" title="basic_static_string::replace (13 of 14 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="overload11.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../replace.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="overload13.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.replace.overload12"></a><a class="link" href="overload12.html" title="basic_static_string::replace (12 of 14 overloads)">basic_static_string::replace
28          (12 of 14 overloads)</a>
29</h5></div></div></div>
30<p>
31            Replace a part of the string.
32          </p>
33<h6>
34<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.h0"></a>
35            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.synopsis"></a></span><a class="link" href="overload12.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload12.synopsis">Synopsis</a>
36          </h6>
37<pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">basic_static_string</span><span class="special">&amp;</span>
38<span class="identifier">replace</span><span class="special">(</span>
39    <span class="identifier">const_iterator</span> <span class="identifier">i1</span><span class="special">,</span>
40    <span class="identifier">const_iterator</span> <span class="identifier">i2</span><span class="special">,</span>
41    <span class="identifier">size_type</span> <span class="identifier">n</span><span class="special">,</span>
42    <span class="identifier">value_type</span> <span class="identifier">c</span><span class="special">);</span>
43</pre>
44<h6>
45<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.h1"></a>
46            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.description"></a></span><a class="link" href="overload12.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload12.description">Description</a>
47          </h6>
48<p>
49            Replaces the characters in the range <code class="computeroutput"><span class="special">{</span><span class="identifier">i1</span><span class="special">,</span> <span class="identifier">i2</span><span class="special">)</span></code>
50            with <code class="computeroutput"><span class="identifier">n</span></code> copies of <code class="computeroutput"><span class="identifier">c</span></code>.
51          </p>
52<h6>
53<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.h2"></a>
54            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.precondition"></a></span><a class="link" href="overload12.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload12.precondition">Precondition</a>
55          </h6>
56<p>
57            <code class="computeroutput"><span class="special">{</span><span class="identifier">i1</span><span class="special">,</span> <span class="identifier">i2</span><span class="special">)</span></code>is a valid range.
58          </p>
59<h6>
60<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.h3"></a>
61            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.exception_safety"></a></span><a class="link" href="overload12.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload12.exception_safety">Exception
62            Safety</a>
63          </h6>
64<p>
65            Strong guarantee.
66          </p>
67<h6>
68<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.h4"></a>
69            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.remarks"></a></span><a class="link" href="overload12.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload12.remarks">Remarks</a>
70          </h6>
71<p>
72            All references, pointers, or iterators referring to contained elements
73            are invalidated. Any past-the-end iterators are also invalidated.
74          </p>
75<h6>
76<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.h5"></a>
77            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.return_value"></a></span><a class="link" href="overload12.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload12.return_value">Return
78            Value</a>
79          </h6>
80<p>
81            <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
82          </p>
83<h6>
84<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.h6"></a>
85            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.parameters"></a></span><a class="link" href="overload12.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload12.parameters">Parameters</a>
86          </h6>
87<div class="informaltable"><table class="table">
88<colgroup>
89<col>
90<col>
91</colgroup>
92<thead><tr>
93<th>
94                    <p>
95                      Name
96                    </p>
97                  </th>
98<th>
99                    <p>
100                      Description
101                    </p>
102                  </th>
103</tr></thead>
104<tbody>
105<tr>
106<td>
107                    <p>
108                      <code class="computeroutput"><span class="identifier">i1</span></code>
109                    </p>
110                  </td>
111<td>
112                    <p>
113                      An iterator referring to the first character to replace.
114                    </p>
115                  </td>
116</tr>
117<tr>
118<td>
119                    <p>
120                      <code class="computeroutput"><span class="identifier">i2</span></code>
121                    </p>
122                  </td>
123<td>
124                    <p>
125                      An iterator past the end of the last character to replace.
126                    </p>
127                  </td>
128</tr>
129<tr>
130<td>
131                    <p>
132                      <code class="computeroutput"><span class="identifier">n</span></code>
133                    </p>
134                  </td>
135<td>
136                    <p>
137                      The number of characters to replace with.
138                    </p>
139                  </td>
140</tr>
141<tr>
142<td>
143                    <p>
144                      <code class="computeroutput"><span class="identifier">c</span></code>
145                    </p>
146                  </td>
147<td>
148                    <p>
149                      The character to replace with.
150                    </p>
151                  </td>
152</tr>
153</tbody>
154</table></div>
155<h6>
156<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.h7"></a>
157            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload12.exceptions"></a></span><a class="link" href="overload12.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload12.exceptions">Exceptions</a>
158          </h6>
159<div class="informaltable"><table class="table">
160<colgroup>
161<col>
162<col>
163</colgroup>
164<thead><tr>
165<th>
166                    <p>
167                      Type
168                    </p>
169                  </th>
170<th>
171                    <p>
172                      Thrown On
173                    </p>
174                  </th>
175</tr></thead>
176<tbody><tr>
177<td>
178                    <p>
179                      <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code>
180                    </p>
181                  </td>
182<td>
183                    <p>
184                      <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>
185                      + (n - std::distance(i1, i2)) &gt; <a class="link" href="../max_size.html" title="basic_static_string::max_size"><code class="computeroutput"><span class="identifier">max_size</span><span class="special">()</span></code></a>
186                    </p>
187                  </td>
188</tr></tbody>
189</table></div>
190</div>
191<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
192<td align="left"></td>
193<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie
194      Falco<p>
195        Distributed under the Boost Software License, Version 1.0. (See accompanying
196        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>)
197      </p>
198</div></td>
199</tr></table>
200<hr>
201<div class="spirit-nav">
202<a accesskey="p" href="overload11.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../replace.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="overload13.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
203</div>
204</body>
205</html>
206