1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_static_string::replace (1 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="../replace.html" title="basic_static_string::replace"> 10<link rel="next" href="overload2.html" title="basic_static_string::replace (2 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="../replace.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="overload2.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.overload1"></a><a class="link" href="overload1.html" title="basic_static_string::replace (1 of 14 overloads)">basic_static_string::replace 28 (1 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.overload1.h0"></a> 35 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.synopsis"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload1.synopsis">Synopsis</a> 36 </h6> 37<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 38 <span class="identifier">size_t</span> <span class="identifier">M</span><span class="special">></span> 39<span class="keyword">constexpr</span> <span class="identifier">basic_static_string</span><span class="special">&</span> 40<span class="identifier">replace</span><span class="special">(</span> 41 <span class="identifier">size_type</span> <span class="identifier">pos1</span><span class="special">,</span> 42 <span class="identifier">size_type</span> <span class="identifier">n1</span><span class="special">,</span> 43 <span class="keyword">const</span> <span class="identifier">basic_static_string</span><span class="special"><</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">>&</span> <span class="identifier">str</span><span class="special">);</span> 44</pre> 45<h6> 46<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.h1"></a> 47 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.description"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload1.description">Description</a> 48 </h6> 49<p> 50 Replaces <code class="computeroutput"><span class="identifier">rcount</span></code> characters 51 starting at index <code class="computeroutput"><span class="identifier">pos1</span></code> 52 with those of <code class="computeroutput"><span class="identifier">str</span></code>, where 53 <code class="computeroutput"><span class="identifier">rcount</span></code> is std::min(n1, 54 <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> 55 - pos1). 56 </p> 57<h6> 58<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.h2"></a> 59 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.exception_safety"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload1.exception_safety">Exception 60 Safety</a> 61 </h6> 62<p> 63 Strong guarantee. 64 </p> 65<h6> 66<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.h3"></a> 67 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.remarks"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload1.remarks">Remarks</a> 68 </h6> 69<p> 70 The replacement is done unchecked when the capacity of <code class="computeroutput"><span class="identifier">str</span></code> differs from that of the string 71 the function is called on. All references, pointers, or iterators referring 72 to contained elements are invalidated. Any past-the-end iterators are 73 also invalidated. 74 </p> 75<h6> 76<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.h4"></a> 77 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.template_parameters"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload1.template_parameters">Template 78 Parameters</a> 79 </h6> 80<div class="informaltable"><table class="table"> 81<colgroup> 82<col> 83<col> 84</colgroup> 85<thead><tr> 86<th> 87 <p> 88 Type 89 </p> 90 </th> 91<th> 92 <p> 93 Description 94 </p> 95 </th> 96</tr></thead> 97<tbody><tr> 98<td> 99 <p> 100 <code class="computeroutput"><span class="identifier">M</span></code> 101 </p> 102 </td> 103<td> 104 <p> 105 The size of the input string. 106 </p> 107 </td> 108</tr></tbody> 109</table></div> 110<h6> 111<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.h5"></a> 112 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.return_value"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload1.return_value">Return 113 Value</a> 114 </h6> 115<p> 116 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 117 </p> 118<h6> 119<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.h6"></a> 120 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.parameters"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload1.parameters">Parameters</a> 121 </h6> 122<div class="informaltable"><table class="table"> 123<colgroup> 124<col> 125<col> 126</colgroup> 127<thead><tr> 128<th> 129 <p> 130 Name 131 </p> 132 </th> 133<th> 134 <p> 135 Description 136 </p> 137 </th> 138</tr></thead> 139<tbody> 140<tr> 141<td> 142 <p> 143 <code class="computeroutput"><span class="identifier">pos1</span></code> 144 </p> 145 </td> 146<td> 147 <p> 148 The index to replace at. 149 </p> 150 </td> 151</tr> 152<tr> 153<td> 154 <p> 155 <code class="computeroutput"><span class="identifier">n1</span></code> 156 </p> 157 </td> 158<td> 159 <p> 160 The number of characters to replace. 161 </p> 162 </td> 163</tr> 164<tr> 165<td> 166 <p> 167 <code class="computeroutput"><span class="identifier">str</span></code> 168 </p> 169 </td> 170<td> 171 <p> 172 The string to replace with. 173 </p> 174 </td> 175</tr> 176</tbody> 177</table></div> 178<h6> 179<a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.h7"></a> 180 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.replace.overload1.exceptions"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.replace.overload1.exceptions">Exceptions</a> 181 </h6> 182<div class="informaltable"><table class="table"> 183<colgroup> 184<col> 185<col> 186</colgroup> 187<thead><tr> 188<th> 189 <p> 190 Type 191 </p> 192 </th> 193<th> 194 <p> 195 Thrown On 196 </p> 197 </th> 198</tr></thead> 199<tbody> 200<tr> 201<td> 202 <p> 203 <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code> 204 </p> 205 </td> 206<td> 207 <p> 208 <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> 209 + (str.size() - rcount) > <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> 210 </p> 211 </td> 212</tr> 213<tr> 214<td> 215 <p> 216 <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">out_of_range</span></code> 217 </p> 218 </td> 219<td> 220 <p> 221 pos1 > <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> 222 </p> 223 </td> 224</tr> 225</tbody> 226</table></div> 227</div> 228<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 229<td align="left"></td> 230<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie 231 Falco<p> 232 Distributed under the Boost Software License, Version 1.0. (See accompanying 233 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>) 234 </p> 235</div></td> 236</tr></table> 237<hr> 238<div class="spirit-nav"> 239<a accesskey="p" href="../replace.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="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 240</div> 241</body> 242</html> 243
