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