1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 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 1. Boost.Beast"> 8<link rel="up" href="../boost__beast__flat_static_buffer.html" title="flat_static_buffer"> 9<link rel="prev" href="cdata.html" title="flat_static_buffer::cdata"> 10<link rel="next" href="commit.html" title="flat_static_buffer::commit"> 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="cdata.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="commit.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="idm46057537365792"></a> 31 </p> 32<p> 33 Returns a mutable buffer sequence representing writable bytes. 34 </p> 35<h6> 36<a name="beast.ref.boost__beast__flat_static_buffer.prepare.h0"></a> 37 <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> 38 </h6> 39<pre class="programlisting"><span class="identifier">mutable_buffers_type</span> 40<span class="identifier">prepare</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__flat_static_buffer.prepare.h1"></a> 45 <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> 46 </h6> 47<p> 48 Returns a mutable buffer sequence representing the writable bytes containing 49 exactly <code class="computeroutput"><span class="identifier">n</span></code> bytes of storage. 50 All buffers sequences previously obtained using <a class="link" href="data/overload1.html" title="flat_static_buffer::data (1 of 2 overloads)"><code class="computeroutput"><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">prepare</span></code></a> are invalidated. 51 </p> 52<h6> 53<a name="beast.ref.boost__beast__flat_static_buffer.prepare.h2"></a> 54 <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> 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 desired number of bytes in the returned buffer sequence. 82 </p> 83 </td> 84</tr></tbody> 85</table></div> 86<h6> 87<a name="beast.ref.boost__beast__flat_static_buffer.prepare.h3"></a> 88 <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> 89 </h6> 90<div class="informaltable"><table class="table"> 91<colgroup> 92<col> 93<col> 94</colgroup> 95<thead><tr> 96<th> 97 <p> 98 Type 99 </p> 100 </th> 101<th> 102 <p> 103 Thrown On 104 </p> 105 </th> 106</tr></thead> 107<tbody><tr> 108<td> 109 <p> 110 <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code> 111 </p> 112 </td> 113<td> 114 <p> 115 if <a class="link" href="size.html" title="flat_static_buffer::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a> 116 + n exceeds <a class="link" href="../boost__beast__flat_static_buffer_base/max_size.html" title="flat_static_buffer_base::max_size"><code class="computeroutput"><span class="identifier">max_size</span><span class="special">()</span></code></a>. 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 © 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="cdata.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="commit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 142</div> 143</body> 144</html> 145
