libs/beast/doc/html/beast/ref/boost__beast__basic_flat_buffer/reserve.html

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