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