• 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 (8 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="overload7.html" title="basic_static_string::insert (7 of 11 overloads)">
10<link rel="next" href="overload9.html" title="basic_static_string::insert (9 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="overload7.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="overload9.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.overload8"></a><a class="link" href="overload8.html" title="basic_static_string::insert (8 of 11 overloads)">basic_static_string::insert
28          (8 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.overload8.h0"></a>
35            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.synopsis"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.synopsis">Synopsis</a>
36          </h6>
37<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
38    <span class="special">[</span><span class="identifier">role</span> <span class="identifier">red</span> <span class="identifier">error</span><span class="special">.</span><span class="identifier">param</span> <span class="identifier">neither</span> <span class="identifier">has</span> <span class="identifier">a</span> <span class="identifier">declname</span> <span class="identifier">nor</span> <span class="identifier">a</span> <span class="char">'class '</span> <span class="identifier">prefix</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">type</span><span class="special">][</span><span class="identifier">role</span> <span class="identifier">red</span> <span class="identifier">error</span><span class="special">.</span><span class="identifier">param</span> <span class="identifier">neither</span> <span class="identifier">has</span> <span class="identifier">a</span> <span class="identifier">declname</span> <span class="identifier">nor</span> <span class="identifier">a</span> <span class="char">'class '</span> <span class="identifier">prefix</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">type</span><span class="special">][</span><span class="identifier">role</span> <span class="identifier">red</span> <span class="identifier">error</span><span class="special">.</span><span class="identifier">param</span> <span class="identifier">neither</span> <span class="identifier">has</span> <span class="identifier">a</span> <span class="identifier">declname</span> <span class="identifier">nor</span> <span class="identifier">a</span> <span class="char">'class '</span> <span class="identifier">prefix</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">type</span><span class="special">][</span><span class="identifier">role</span> <span class="identifier">red</span> <span class="identifier">error</span><span class="special">.</span><span class="identifier">param</span> <span class="identifier">neither</span> <span class="identifier">has</span> <span class="identifier">a</span> <span class="identifier">declname</span> <span class="identifier">nor</span> <span class="identifier">a</span> <span class="char">'class '</span> <span class="identifier">prefix</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">type</span><span class="special">]&gt;</span>
39<span class="keyword">constexpr</span> <span class="identifier">iterator</span>
40<span class="identifier">insert</span><span class="special">(</span>
41    <span class="identifier">const_iterator</span> <span class="identifier">pos</span><span class="special">,</span>
42    <span class="identifier">InputIterator</span> <span class="identifier">first</span><span class="special">,</span>
43    <span class="identifier">InputIterator</span> <span class="identifier">last</span><span class="special">);</span>
44</pre>
45<h6>
46<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h1"></a>
47            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.description"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.description">Description</a>
48          </h6>
49<p>
50            Inserts characters from the range <code class="computeroutput"><span class="special">{</span><span class="identifier">first</span><span class="special">,</span> <span class="identifier">last</span><span class="special">)</span></code>
51            before the character pointed to by <code class="computeroutput"><span class="identifier">pos</span></code>.
52          </p>
53<h6>
54<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h2"></a>
55            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.precondition"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.precondition">Precondition</a>
56          </h6>
57<p>
58            <code class="computeroutput"><span class="identifier">pos</span></code>shall be valid within
59            {<a class="link" href="../data/overload1.html" title="basic_static_string::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code></a>,
60            <a class="link" href="../data/overload1.html" title="basic_static_string::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code></a>
61            + <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>},
62            <code class="computeroutput"><span class="special">{</span><span class="identifier">first</span><span class="special">,</span> <span class="identifier">last</span><span class="special">)</span></code> shall be a valid range
63          </p>
64<h6>
65<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h3"></a>
66            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.exception_safety"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.exception_safety">Exception
67            Safety</a>
68          </h6>
69<p>
70            Strong guarantee.
71          </p>
72<h6>
73<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h4"></a>
74            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.remarks"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.remarks">Remarks</a>
75          </h6>
76<p>
77            All references, pointers, or iterators referring to contained elements
78            are invalidated. Any past-the-end iterators are also invalidated.
79          </p>
80<h6>
81<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h5"></a>
82            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.template_parameters"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.template_parameters">Template
83            Parameters</a>
84          </h6>
85<div class="informaltable"><table class="table">
86<colgroup>
87<col>
88<col>
89</colgroup>
90<thead><tr>
91<th>
92                    <p>
93                      Type
94                    </p>
95                  </th>
96<th>
97                    <p>
98                      Description
99                    </p>
100                  </th>
101</tr></thead>
102<tbody><tr>
103<td>
104                    <p>
105                      <code class="computeroutput"><span class="identifier">InputIterator</span></code>
106                    </p>
107                  </td>
108<td>
109                    <p>
110                      The type of the iterators.
111                    </p>
112                  </td>
113</tr></tbody>
114</table></div>
115<h6>
116<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h6"></a>
117            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.constraints"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.constraints">Constraints</a>
118          </h6>
119<p>
120            <code class="computeroutput"><span class="identifier">InputIterator</span></code>satisfies
121            <span class="bold"><strong>InputIterator</strong></span> and does not satisfy
122            <span class="bold"><strong>ForwardIterator</strong></span>.
123          </p>
124<h6>
125<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h7"></a>
126            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.return_value"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.return_value">Return
127            Value</a>
128          </h6>
129<p>
130            An iterator which refers to the first inserted character or <code class="computeroutput"><span class="identifier">pos</span></code> if no characters were inserted
131          </p>
132<h6>
133<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h8"></a>
134            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.parameters"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.parameters">Parameters</a>
135          </h6>
136<div class="informaltable"><table class="table">
137<colgroup>
138<col>
139<col>
140</colgroup>
141<thead><tr>
142<th>
143                    <p>
144                      Name
145                    </p>
146                  </th>
147<th>
148                    <p>
149                      Description
150                    </p>
151                  </th>
152</tr></thead>
153<tbody>
154<tr>
155<td>
156                    <p>
157                      <code class="computeroutput"><span class="identifier">pos</span></code>
158                    </p>
159                  </td>
160<td>
161                    <p>
162                      The position to insert at.
163                    </p>
164                  </td>
165</tr>
166<tr>
167<td>
168                    <p>
169                      <code class="computeroutput"><span class="identifier">first</span></code>
170                    </p>
171                  </td>
172<td>
173                    <p>
174                      An iterator representing the first character to insert.
175                    </p>
176                  </td>
177</tr>
178<tr>
179<td>
180                    <p>
181                      <code class="computeroutput"><span class="identifier">last</span></code>
182                    </p>
183                  </td>
184<td>
185                    <p>
186                      An iterator representing one past the last character to insert.
187                    </p>
188                  </td>
189</tr>
190</tbody>
191</table></div>
192<h6>
193<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.h9"></a>
194            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload8.exceptions"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload8.exceptions">Exceptions</a>
195          </h6>
196<div class="informaltable"><table class="table">
197<colgroup>
198<col>
199<col>
200</colgroup>
201<thead><tr>
202<th>
203                    <p>
204                      Type
205                    </p>
206                  </th>
207<th>
208                    <p>
209                      Thrown On
210                    </p>
211                  </th>
212</tr></thead>
213<tbody><tr>
214<td>
215                    <p>
216                      <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code>
217                    </p>
218                  </td>
219<td>
220                    <p>
221                      <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                      + insert_count &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>
223                    </p>
224                  </td>
225</tr></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="overload7.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="overload9.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
240</div>
241</body>
242</html>
243