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