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

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