1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_multi_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__basic_multi_buffer.html" title="basic_multi_buffer"> 9<link rel="prev" href="cdata.html" title="basic_multi_buffer::cdata"> 10<link rel="next" href="commit.html" title="basic_multi_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__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="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__basic_multi_buffer.prepare"></a><a class="link" href="prepare.html" title="basic_multi_buffer::prepare">basic_multi_buffer::prepare</a> 28</h5></div></div></div> 29<p> 30 <a class="indexterm" name="idm46057547805120"></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__basic_multi_buffer.prepare.h0"></a> 37 <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.synopsis"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_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">size_type</span> <span class="identifier">n</span><span class="special">);</span> 42</pre> 43<h6> 44<a name="beast.ref.boost__beast__basic_multi_buffer.prepare.h1"></a> 45 <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.description"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_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 Memory may be reallocated as needed. All buffer sequences previously obtained 51 using <a class="link" href="prepare.html" title="basic_multi_buffer::prepare"><code class="computeroutput"><span class="identifier">prepare</span></code></a> are invalidated. Buffer 52 sequences previously obtained using <a class="link" href="data/overload1.html" title="basic_multi_buffer::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span></code></a> remain valid. 53 </p> 54<h6> 55<a name="beast.ref.boost__beast__basic_multi_buffer.prepare.h2"></a> 56 <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.parameters"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_buffer.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__basic_multi_buffer.prepare.h3"></a> 90 <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.exceptions"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_buffer.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 <a class="link" href="size.html" title="basic_multi_buffer::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a> 118 + n exceeds <a class="link" href="max_size/overload1.html" title="basic_multi_buffer::max_size (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">max_size</span><span class="special">()</span></code></a>. 119 </p> 120 </td> 121</tr></tbody> 122</table></div> 123<h6> 124<a name="beast.ref.boost__beast__basic_multi_buffer.prepare.h4"></a> 125 <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.exception_safety"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_buffer.prepare.exception_safety">Exception 126 Safety</a> 127 </h6> 128<p> 129 Strong guarantee. 130 </p> 131</div> 132<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 133<td align="left"></td> 134<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 135 Falco<p> 136 Distributed under the Boost Software License, Version 1.0. (See accompanying 137 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>) 138 </p> 139</div></td> 140</tr></table> 141<hr> 142<div class="spirit-nav"> 143<a accesskey="p" href="cdata.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="commit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 144</div> 145</body> 146</html> 147
