libs/beast/doc/html/beast/ref/boost__beast__buffers_adaptor/prepare.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>buffers_adaptor::prepare</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__buffers_adaptor.html" title="buffers_adaptor">
   9 <link rel="prev" href="operator_eq_.html" title="buffers_adaptor::operator=">
  10 <link rel="next" href="size.html" title="buffers_adaptor::size">
  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="operator_eq_.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__buffers_adaptor.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="size.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__buffers_adaptor.prepare"></a><a class="link" href="prepare.html" title="buffers_adaptor::prepare">buffers_adaptor::prepare</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873512751776"></a>
  31 Returns a mutable buffer sequence representing writable
  32           bytes.
  33         </p>
  34 <h6>
  35 <a name="beast.ref.boost__beast__buffers_adaptor.prepare.h0"></a>
  36           <span class="phrase"><a name="beast.ref.boost__beast__buffers_adaptor.prepare.synopsis"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__buffers_adaptor.prepare.synopsis">Synopsis</a>
  37         </h6>
  38 <pre class="programlisting"><span class="identifier">mutable_buffers_type</span>
  39 <span class="identifier">prepare</span><span class="special">(</span>
  40     <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span><span class="special">);</span>
  41 </pre>
  42 <h6>
  43 <a name="beast.ref.boost__beast__buffers_adaptor.prepare.h1"></a>
  44           <span class="phrase"><a name="beast.ref.boost__beast__buffers_adaptor.prepare.description"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__buffers_adaptor.prepare.description">Description</a>
  45         </h6>
  46 <p>
  47           Returns a mutable buffer sequence representing the writable bytes containing
  48           exactly <code class="computeroutput"><span class="identifier">n</span></code> bytes of storage.
  49           This function does not allocate memory. Instead, the storage comes from
  50           the underlying mutable buffer sequence. All buffer sequences previously
  51           obtained using <a class="link" href="prepare.html" title="buffers_adaptor::prepare"><code class="computeroutput"><span class="identifier">buffers_adaptor</span><span class="special">::</span><span class="identifier">prepare</span></code></a> are invalidated. Buffer
  52           sequences previously obtained using <a class="link" href="data.html" title="buffers_adaptor::data"><code class="computeroutput"><span class="identifier">buffers_adaptor</span><span class="special">::</span><span class="identifier">data</span></code></a> remain valid.
  53         </p>
  54 <h6>
  55 <a name="beast.ref.boost__beast__buffers_adaptor.prepare.h2"></a>
  56           <span class="phrase"><a name="beast.ref.boost__beast__buffers_adaptor.prepare.parameters"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__buffers_adaptor.prepare.parameters">Parameters</a>
  57         </h6>
  58 <div class="informaltable"><table class="table">
  59 <colgroup>
  60 <col>
  61 <col>
  62 </colgroup>
  63 <thead><tr>
  64 <th>
  65                   <p>
  66                     Name
  67                   </p>
  68                 </th>
  69 <th>
  70                   <p>
  71                     Description
  72                   </p>
  73                 </th>
  74 </tr></thead>
  75 <tbody><tr>
  76 <td>
  77                   <p>
  78                     <code class="computeroutput"><span class="identifier">n</span></code>
  79                   </p>
  80                 </td>
  81 <td>
  82                   <p>
  83                     The desired number of bytes in the returned buffer sequence.
  84                   </p>
  85                 </td>
  86 </tr></tbody>
  87 </table></div>
  88 <h6>
  89 <a name="beast.ref.boost__beast__buffers_adaptor.prepare.h3"></a>
  90           <span class="phrase"><a name="beast.ref.boost__beast__buffers_adaptor.prepare.exceptions"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__buffers_adaptor.prepare.exceptions">Exceptions</a>
  91         </h6>
  92 <div class="informaltable"><table class="table">
  93 <colgroup>
  94 <col>
  95 <col>
  96 </colgroup>
  97 <thead><tr>
  98 <th>
  99                   <p>
 100                     Type
 101                   </p>
 102                 </th>
 103 <th>
 104                   <p>
 105                     Thrown On
 106                   </p>
 107                 </th>
 108 </tr></thead>
 109 <tbody><tr>
 110 <td>
 111                   <p>
 112                     <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code>
 113                   </p>
 114                 </td>
 115 <td>
 116                   <p>
 117                     if <code class="computeroutput"><span class="identifier">size</span><span class="special">()</span>
 118                     <span class="special">+</span> <span class="identifier">n</span></code>
 119                     exceeds <code class="computeroutput"><span class="identifier">max_size</span><span class="special">()</span></code>.
 120                   </p>
 121                 </td>
 122 </tr></tbody>
 123 </table></div>
 124 <h6>
 125 <a name="beast.ref.boost__beast__buffers_adaptor.prepare.h4"></a>
 126           <span class="phrase"><a name="beast.ref.boost__beast__buffers_adaptor.prepare.exception_safety"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__buffers_adaptor.prepare.exception_safety">Exception
 127           Safety</a>
 128         </h6>
 129 <p>
 130           Strong guarantee.
 131         </p>
 132 </div>
 133 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 134 <td align="left"></td>
 135 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 136       Falco<p>
 137         Distributed under the Boost Software License, Version 1.0. (See accompanying
 138         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>)
 139       </p>
 140 </div></td>
 141 </tr></table>
 142 <hr>
 143 <div class="spirit-nav">
 144 <a accesskey="p" href="operator_eq_.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__buffers_adaptor.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="size.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 145 </div>
 146 </body>
 147 </html>