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