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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>flat_static_buffer::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__flat_static_buffer.html" title="flat_static_buffer">
   9 <link rel="prev" href="operator_eq_.html" title="flat_static_buffer::operator=">
  10 <link rel="next" href="reset.html" title="flat_static_buffer::reset">
  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__flat_static_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="reset.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__flat_static_buffer.prepare"></a><a class="link" href="prepare.html" title="flat_static_buffer::prepare">flat_static_buffer::prepare</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873508784336"></a>
  31 Returns a mutable buffer sequence representing
  32           writable bytes.
  33         </p>
  34 <h6>
  35 <a name="beast.ref.boost__beast__flat_static_buffer.prepare.h0"></a>
  36           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer.prepare.synopsis"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__flat_static_buffer.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__flat_static_buffer.prepare.h1"></a>
  44           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer.prepare.description"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__flat_static_buffer.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           All buffers sequences previously obtained using <a class="link" href="data.html" title="flat_static_buffer::data"><code class="computeroutput"><span class="identifier">flat_static_buffer</span><span class="special">::</span><span class="identifier">data</span></code></a> or <a class="link" href="prepare.html" title="flat_static_buffer::prepare"><code class="computeroutput"><span class="identifier">flat_static_buffer</span><span class="special">::</span><span class="identifier">prepare</span></code></a> are invalidated.
  50         </p>
  51 <h6>
  52 <a name="beast.ref.boost__beast__flat_static_buffer.prepare.h2"></a>
  53           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer.prepare.parameters"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__flat_static_buffer.prepare.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 desired number of bytes in the returned buffer sequence.
  81                   </p>
  82                 </td>
  83 </tr></tbody>
  84 </table></div>
  85 <h6>
  86 <a name="beast.ref.boost__beast__flat_static_buffer.prepare.h3"></a>
  87           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer.prepare.exceptions"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__flat_static_buffer.prepare.exceptions">Exceptions</a>
  88         </h6>
  89 <div class="informaltable"><table class="table">
  90 <colgroup>
  91 <col>
  92 <col>
  93 </colgroup>
  94 <thead><tr>
  95 <th>
  96                   <p>
  97                     Type
  98                   </p>
  99                 </th>
 100 <th>
 101                   <p>
 102                     Thrown On
 103                   </p>
 104                 </th>
 105 </tr></thead>
 106 <tbody><tr>
 107 <td>
 108                   <p>
 109                     <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code>
 110                   </p>
 111                 </td>
 112 <td>
 113                   <p>
 114                     if <code class="computeroutput"><span class="identifier">size</span><span class="special">()</span>
 115                     <span class="special">+</span> <span class="identifier">n</span></code>
 116                     exceeds <code class="computeroutput"><span class="identifier">max_size</span><span class="special">()</span></code>.
 117                   </p>
 118                 </td>
 119 </tr></tbody>
 120 </table></div>
 121 <h6>
 122 <a name="beast.ref.boost__beast__flat_static_buffer.prepare.h4"></a>
 123           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer.prepare.exception_safety"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__flat_static_buffer.prepare.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="operator_eq_.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__flat_static_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="reset.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 142 </div>
 143 </body>
 144 </html>