• 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 (7 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="overload6.html" title="basic_static_string::insert (6 of 11 overloads)">
10<link rel="next" href="overload8.html" title="basic_static_string::insert (8 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="overload6.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="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.insert.overload7"></a><a class="link" href="overload7.html" title="basic_static_string::insert (7 of 11 overloads)">basic_static_string::insert
28          (7 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.overload7.h0"></a>
35            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.synopsis"></a></span><a class="link" href="overload7.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload7.synopsis">Synopsis</a>
36          </h6>
37<pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">iterator</span>
38<span class="identifier">insert</span><span class="special">(</span>
39    <span class="identifier">const_iterator</span> <span class="identifier">pos</span><span class="special">,</span>
40    <span class="identifier">size_type</span> <span class="identifier">count</span><span class="special">,</span>
41    <span class="identifier">value_type</span> <span class="identifier">ch</span><span class="special">);</span>
42</pre>
43<h6>
44<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.h1"></a>
45            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.description"></a></span><a class="link" href="overload7.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload7.description">Description</a>
46          </h6>
47<p>
48            Inserts <code class="computeroutput"><span class="identifier">count</span></code> copies
49            of <code class="computeroutput"><span class="identifier">ch</span></code> before the character
50            pointed by <code class="computeroutput"><span class="identifier">pos</span></code>.
51          </p>
52<h6>
53<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.h2"></a>
54            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.precondition"></a></span><a class="link" href="overload7.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload7.precondition">Precondition</a>
55          </h6>
56<p>
57            <code class="computeroutput"><span class="identifier">pos</span></code>shall be valid within
58            {<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>,
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="../size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a>}
61          </p>
62<h6>
63<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.h3"></a>
64            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.exception_safety"></a></span><a class="link" href="overload7.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload7.exception_safety">Exception
65            Safety</a>
66          </h6>
67<p>
68            Strong guarantee.
69          </p>
70<h6>
71<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.h4"></a>
72            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.remarks"></a></span><a class="link" href="overload7.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload7.remarks">Remarks</a>
73          </h6>
74<p>
75            All references, pointers, or iterators referring to contained elements
76            are invalidated. Any past-the-end iterators are also invalidated.
77          </p>
78<h6>
79<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.h5"></a>
80            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.return_value"></a></span><a class="link" href="overload7.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload7.return_value">Return
81            Value</a>
82          </h6>
83<p>
84            An iterator which refers to the first inserted character or <code class="computeroutput"><span class="identifier">pos</span></code> if no characters were inserted
85          </p>
86<h6>
87<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.h6"></a>
88            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.parameters"></a></span><a class="link" href="overload7.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload7.parameters">Parameters</a>
89          </h6>
90<div class="informaltable"><table class="table">
91<colgroup>
92<col>
93<col>
94</colgroup>
95<thead><tr>
96<th>
97                    <p>
98                      Name
99                    </p>
100                  </th>
101<th>
102                    <p>
103                      Description
104                    </p>
105                  </th>
106</tr></thead>
107<tbody>
108<tr>
109<td>
110                    <p>
111                      <code class="computeroutput"><span class="identifier">pos</span></code>
112                    </p>
113                  </td>
114<td>
115                    <p>
116                      The position to insert at.
117                    </p>
118                  </td>
119</tr>
120<tr>
121<td>
122                    <p>
123                      <code class="computeroutput"><span class="identifier">count</span></code>
124                    </p>
125                  </td>
126<td>
127                    <p>
128                      The number of characters to insert.
129                    </p>
130                  </td>
131</tr>
132<tr>
133<td>
134                    <p>
135                      <code class="computeroutput"><span class="identifier">ch</span></code>
136                    </p>
137                  </td>
138<td>
139                    <p>
140                      The character to insert.
141                    </p>
142                  </td>
143</tr>
144</tbody>
145</table></div>
146<h6>
147<a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.h7"></a>
148            <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.insert.overload7.exceptions"></a></span><a class="link" href="overload7.html#static_string.ref.boost__static_strings__basic_static_string.insert.overload7.exceptions">Exceptions</a>
149          </h6>
150<div class="informaltable"><table class="table">
151<colgroup>
152<col>
153<col>
154</colgroup>
155<thead><tr>
156<th>
157                    <p>
158                      Type
159                    </p>
160                  </th>
161<th>
162                    <p>
163                      Thrown On
164                    </p>
165                  </th>
166</tr></thead>
167<tbody><tr>
168<td>
169                    <p>
170                      <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code>
171                    </p>
172                  </td>
173<td>
174                    <p>
175                      <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>
176                      + 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>
177                    </p>
178                  </td>
179</tr></tbody>
180</table></div>
181</div>
182<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
183<td align="left"></td>
184<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie
185      Falco<p>
186        Distributed under the Boost Software License, Version 1.0. (See accompanying
187        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>)
188      </p>
189</div></td>
190</tr></table>
191<hr>
192<div class="spirit-nav">
193<a accesskey="p" href="overload6.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="overload8.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
194</div>
195</body>
196</html>
197