• 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_multi_buffer::reserve</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="Chapter 1. Boost.Beast">
8<link rel="up" href="../boost__beast__basic_multi_buffer.html" title="basic_multi_buffer">
9<link rel="prev" href="max_size/overload2.html" title="basic_multi_buffer::max_size (2 of 2 overloads)">
10<link rel="next" href="shrink_to_fit.html" title="basic_multi_buffer::shrink_to_fit">
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="max_size/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_multi_buffer.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="shrink_to_fit.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="beast.ref.boost__beast__basic_multi_buffer.reserve"></a><a class="link" href="reserve.html" title="basic_multi_buffer::reserve">basic_multi_buffer::reserve</a>
28</h5></div></div></div>
29<p>
30          <a class="indexterm" name="idm46057547963024"></a>
31        </p>
32<p>
33          Guarantee a minimum capacity.
34        </p>
35<h6>
36<a name="beast.ref.boost__beast__basic_multi_buffer.reserve.h0"></a>
37          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.reserve.synopsis"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_multi_buffer.reserve.synopsis">Synopsis</a>
38        </h6>
39<pre class="programlisting"><span class="keyword">void</span>
40<span class="identifier">reserve</span><span class="special">(</span>
41    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span><span class="special">);</span>
42</pre>
43<h6>
44<a name="beast.ref.boost__beast__basic_multi_buffer.reserve.h1"></a>
45          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.reserve.description"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_multi_buffer.reserve.description">Description</a>
46        </h6>
47<p>
48          This function adjusts the internal storage (if necessary) to guarantee
49          space for at least <code class="computeroutput"><span class="identifier">n</span></code> bytes.
50          Buffer sequences previously obtained using <a class="link" href="data/overload1.html" title="basic_multi_buffer::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span></code></a> remain valid, while buffer
51          sequences previously obtained using <a class="link" href="prepare.html" title="basic_multi_buffer::prepare"><code class="computeroutput"><span class="identifier">prepare</span></code></a> become invalid.
52        </p>
53<h6>
54<a name="beast.ref.boost__beast__basic_multi_buffer.reserve.h2"></a>
55          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.reserve.parameters"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_multi_buffer.reserve.parameters">Parameters</a>
56        </h6>
57<div class="informaltable"><table class="table">
58<colgroup>
59<col>
60<col>
61</colgroup>
62<thead><tr>
63<th>
64                  <p>
65                    Name
66                  </p>
67                </th>
68<th>
69                  <p>
70                    Description
71                  </p>
72                </th>
73</tr></thead>
74<tbody><tr>
75<td>
76                  <p>
77                    <code class="computeroutput"><span class="identifier">n</span></code>
78                  </p>
79                </td>
80<td>
81                  <p>
82                    The minimum number of byte for the new capacity. If this value
83                    is greater than the maximum size, then the maximum size will
84                    be adjusted upwards to this value.
85                  </p>
86                </td>
87</tr></tbody>
88</table></div>
89<h6>
90<a name="beast.ref.boost__beast__basic_multi_buffer.reserve.h3"></a>
91          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.reserve.exceptions"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_multi_buffer.reserve.exceptions">Exceptions</a>
92        </h6>
93<div class="informaltable"><table class="table">
94<colgroup>
95<col>
96<col>
97</colgroup>
98<thead><tr>
99<th>
100                  <p>
101                    Type
102                  </p>
103                </th>
104<th>
105                  <p>
106                    Thrown On
107                  </p>
108                </th>
109</tr></thead>
110<tbody><tr>
111<td>
112                  <p>
113                    <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code>
114                  </p>
115                </td>
116<td>
117                  <p>
118                    if n is larger than the maximum allocation size of the allocator.
119                  </p>
120                </td>
121</tr></tbody>
122</table></div>
123<h6>
124<a name="beast.ref.boost__beast__basic_multi_buffer.reserve.h4"></a>
125          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.reserve.exception_safety"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_multi_buffer.reserve.exception_safety">Exception
126          Safety</a>
127        </h6>
128<p>
129          Strong guarantee.
130        </p>
131</div>
132<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
133<td align="left"></td>
134<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
135      Falco<p>
136        Distributed under the Boost Software License, Version 1.0. (See accompanying
137        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>)
138      </p>
139</div></td>
140</tr></table>
141<hr>
142<div class="spirit-nav">
143<a accesskey="p" href="max_size/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_multi_buffer.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="shrink_to_fit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
144</div>
145</body>
146</html>
147