• 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_flat_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_flat_buffer.html" title="basic_flat_buffer">
9<link rel="prev" href="max_size/overload2.html" title="basic_flat_buffer::max_size (2 of 2 overloads)">
10<link rel="next" href="shrink_to_fit.html" title="basic_flat_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_flat_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_flat_buffer.reserve"></a><a class="link" href="reserve.html" title="basic_flat_buffer::reserve">basic_flat_buffer::reserve</a>
28</h5></div></div></div>
29<p>
30          <a class="indexterm" name="idm46057549246032"></a>
31        </p>
32<p>
33          Guarantee a minimum capacity.
34        </p>
35<h6>
36<a name="beast.ref.boost__beast__basic_flat_buffer.reserve.h0"></a>
37          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.reserve.synopsis"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_flat_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_flat_buffer.reserve.h1"></a>
45          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.reserve.description"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_flat_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_flat_buffer::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span></code></a> or <a class="link" href="prepare.html" title="basic_flat_buffer::prepare"><code class="computeroutput"><span class="identifier">prepare</span></code></a> become invalid.
51        </p>
52<h6>
53<a name="beast.ref.boost__beast__basic_flat_buffer.reserve.h2"></a>
54          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.reserve.parameters"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_flat_buffer.reserve.parameters">Parameters</a>
55        </h6>
56<div class="informaltable"><table class="table">
57<colgroup>
58<col>
59<col>
60</colgroup>
61<thead><tr>
62<th>
63                  <p>
64                    Name
65                  </p>
66                </th>
67<th>
68                  <p>
69                    Description
70                  </p>
71                </th>
72</tr></thead>
73<tbody><tr>
74<td>
75                  <p>
76                    <code class="computeroutput"><span class="identifier">n</span></code>
77                  </p>
78                </td>
79<td>
80                  <p>
81                    The minimum number of byte for the new capacity. If this value
82                    is greater than the maximum size, then the maximum size will
83                    be adjusted upwards to this value.
84                  </p>
85                </td>
86</tr></tbody>
87</table></div>
88<h6>
89<a name="beast.ref.boost__beast__basic_flat_buffer.reserve.h3"></a>
90          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.reserve.exception_safety"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_flat_buffer.reserve.exception_safety">Exception
91          Safety</a>
92        </h6>
93<p>
94          Basic guarantee.
95        </p>
96<h6>
97<a name="beast.ref.boost__beast__basic_flat_buffer.reserve.h4"></a>
98          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.reserve.exceptions"></a></span><a class="link" href="reserve.html#beast.ref.boost__beast__basic_flat_buffer.reserve.exceptions">Exceptions</a>
99        </h6>
100<div class="informaltable"><table class="table">
101<colgroup>
102<col>
103<col>
104</colgroup>
105<thead><tr>
106<th>
107                  <p>
108                    Type
109                  </p>
110                </th>
111<th>
112                  <p>
113                    Thrown On
114                  </p>
115                </th>
116</tr></thead>
117<tbody><tr>
118<td>
119                  <p>
120                    <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code>
121                  </p>
122                </td>
123<td>
124                  <p>
125                    if n is larger than the maximum allocation size of the allocator.
126                  </p>
127                </td>
128</tr></tbody>
129</table></div>
130</div>
131<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
132<td align="left"></td>
133<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
134      Falco<p>
135        Distributed under the Boost Software License, Version 1.0. (See accompanying
136        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>)
137      </p>
138</div></td>
139</tr></table>
140<hr>
141<div class="spirit-nav">
142<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_flat_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>
143</div>
144</body>
145</html>
146