• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>dynamic_string_buffer</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="../../boost_asio.html" title="Boost.Asio">
8<link rel="up" href="../reference.html" title="Reference">
9<link rel="prev" href="dynamic_buffer/overload4.html" title="dynamic_buffer (4 of 4 overloads)">
10<link rel="next" href="dynamic_string_buffer/capacity.html" title="dynamic_string_buffer::capacity">
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="dynamic_buffer/overload4.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="dynamic_string_buffer/capacity.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="boost_asio.reference.dynamic_string_buffer"></a><a class="link" href="dynamic_string_buffer.html" title="dynamic_string_buffer">dynamic_string_buffer</a>
28</h3></div></div></div>
29<p>
30        Adapt a basic_string to the DynamicBuffer requirements.
31      </p>
32<pre class="programlisting">template&lt;
33    typename Elem,
34    typename Traits,
35    typename Allocator&gt;
36class dynamic_string_buffer
37</pre>
38<h5>
39<a name="boost_asio.reference.dynamic_string_buffer.h0"></a>
40        <span class="phrase"><a name="boost_asio.reference.dynamic_string_buffer.types"></a></span><a class="link" href="dynamic_string_buffer.html#boost_asio.reference.dynamic_string_buffer.types">Types</a>
41      </h5>
42<div class="informaltable"><table class="table">
43<colgroup>
44<col>
45<col>
46</colgroup>
47<thead><tr>
48<th>
49                <p>
50                  Name
51                </p>
52              </th>
53<th>
54                <p>
55                  Description
56                </p>
57              </th>
58</tr></thead>
59<tbody>
60<tr>
61<td>
62                <p>
63                  <a class="link" href="dynamic_string_buffer/const_buffers_type.html" title="dynamic_string_buffer::const_buffers_type"><span class="bold"><strong>const_buffers_type</strong></span></a>
64                </p>
65              </td>
66<td>
67                <p>
68                  The type used to represent a sequence of constant buffers that
69                  refers to the underlying memory.
70                </p>
71              </td>
72</tr>
73<tr>
74<td>
75                <p>
76                  <a class="link" href="dynamic_string_buffer/mutable_buffers_type.html" title="dynamic_string_buffer::mutable_buffers_type"><span class="bold"><strong>mutable_buffers_type</strong></span></a>
77                </p>
78              </td>
79<td>
80                <p>
81                  The type used to represent a sequence of mutable buffers that refers
82                  to the underlying memory.
83                </p>
84              </td>
85</tr>
86</tbody>
87</table></div>
88<h5>
89<a name="boost_asio.reference.dynamic_string_buffer.h1"></a>
90        <span class="phrase"><a name="boost_asio.reference.dynamic_string_buffer.member_functions"></a></span><a class="link" href="dynamic_string_buffer.html#boost_asio.reference.dynamic_string_buffer.member_functions">Member
91        Functions</a>
92      </h5>
93<div class="informaltable"><table class="table">
94<colgroup>
95<col>
96<col>
97</colgroup>
98<thead><tr>
99<th>
100                <p>
101                  Name
102                </p>
103              </th>
104<th>
105                <p>
106                  Description
107                </p>
108              </th>
109</tr></thead>
110<tbody>
111<tr>
112<td>
113                <p>
114                  <a class="link" href="dynamic_string_buffer/capacity.html" title="dynamic_string_buffer::capacity"><span class="bold"><strong>capacity</strong></span></a>
115                </p>
116              </td>
117<td>
118                <p>
119                  Get the maximum size that the buffer may grow to without triggering
120                  reallocation.
121                </p>
122              </td>
123</tr>
124<tr>
125<td>
126                <p>
127                  <a class="link" href="dynamic_string_buffer/commit.html" title="dynamic_string_buffer::commit"><span class="bold"><strong>commit</strong></span></a>
128                </p>
129              </td>
130<td>
131                <p>
132                  DynamicBuffer_v1: Move bytes from the output sequence to the input
133                  sequence.
134                </p>
135              </td>
136</tr>
137<tr>
138<td>
139                <p>
140                  <a class="link" href="dynamic_string_buffer/consume.html" title="dynamic_string_buffer::consume"><span class="bold"><strong>consume</strong></span></a>
141                </p>
142              </td>
143<td>
144                <p>
145                  DynamicBuffer_v1: Remove characters from the input sequence. DynamicBuffer_v2:
146                  Consume the specified number of bytes from the beginning of the
147                  underlying memory.
148                </p>
149              </td>
150</tr>
151<tr>
152<td>
153                <p>
154                  <a class="link" href="dynamic_string_buffer/data.html" title="dynamic_string_buffer::data"><span class="bold"><strong>data</strong></span></a>
155                </p>
156              </td>
157<td>
158                <p>
159                  DynamicBuffer_v1: Get a list of buffers that represents the input
160                  sequence. <br> <span class="silver"> —</span><br> DynamicBuffer_v2: Get a sequence of buffers
161                  that represents the underlying memory.
162                </p>
163              </td>
164</tr>
165<tr>
166<td>
167                <p>
168                  <a class="link" href="dynamic_string_buffer/dynamic_string_buffer.html" title="dynamic_string_buffer::dynamic_string_buffer"><span class="bold"><strong>dynamic_string_buffer</strong></span></a> <span class="silver">[constructor]</span>
169                </p>
170              </td>
171<td>
172                <p>
173                  Construct a dynamic buffer from a string. <br> <span class="silver"> —</span><br> DynamicBuffer_v2:
174                  Copy construct a dynamic buffer. <br> <span class="silver"> —</span><br> Move construct a
175                  dynamic buffer.
176                </p>
177              </td>
178</tr>
179<tr>
180<td>
181                <p>
182                  <a class="link" href="dynamic_string_buffer/grow.html" title="dynamic_string_buffer::grow"><span class="bold"><strong>grow</strong></span></a>
183                </p>
184              </td>
185<td>
186                <p>
187                  DynamicBuffer_v2: Grow the underlying memory by the specified number
188                  of bytes.
189                </p>
190              </td>
191</tr>
192<tr>
193<td>
194                <p>
195                  <a class="link" href="dynamic_string_buffer/max_size.html" title="dynamic_string_buffer::max_size"><span class="bold"><strong>max_size</strong></span></a>
196                </p>
197              </td>
198<td>
199                <p>
200                  Get the maximum size of the dynamic buffer.
201                </p>
202              </td>
203</tr>
204<tr>
205<td>
206                <p>
207                  <a class="link" href="dynamic_string_buffer/prepare.html" title="dynamic_string_buffer::prepare"><span class="bold"><strong>prepare</strong></span></a>
208                </p>
209              </td>
210<td>
211                <p>
212                  DynamicBuffer_v1: Get a list of buffers that represents the output
213                  sequence, with the given size.
214                </p>
215              </td>
216</tr>
217<tr>
218<td>
219                <p>
220                  <a class="link" href="dynamic_string_buffer/shrink.html" title="dynamic_string_buffer::shrink"><span class="bold"><strong>shrink</strong></span></a>
221                </p>
222              </td>
223<td>
224                <p>
225                  DynamicBuffer_v2: Shrink the underlying memory by the specified
226                  number of bytes.
227                </p>
228              </td>
229</tr>
230<tr>
231<td>
232                <p>
233                  <a class="link" href="dynamic_string_buffer/size.html" title="dynamic_string_buffer::size"><span class="bold"><strong>size</strong></span></a>
234                </p>
235              </td>
236<td>
237                <p>
238                  DynamicBuffer_v1: Get the size of the input sequence. DynamicBuffer_v2:
239                  Get the current size of the underlying memory.
240                </p>
241              </td>
242</tr>
243</tbody>
244</table></div>
245<p>
246        Requires that <code class="computeroutput">sizeof(Elem) == 1</code>.
247      </p>
248<h5>
249<a name="boost_asio.reference.dynamic_string_buffer.h2"></a>
250        <span class="phrase"><a name="boost_asio.reference.dynamic_string_buffer.requirements"></a></span><a class="link" href="dynamic_string_buffer.html#boost_asio.reference.dynamic_string_buffer.requirements">Requirements</a>
251      </h5>
252<p>
253        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/buffer.hpp</code>
254      </p>
255<p>
256        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
257      </p>
258</div>
259<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
260<td align="left"></td>
261<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
262      Kohlhoff<p>
263        Distributed under the Boost Software License, Version 1.0. (See accompanying
264        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>)
265      </p>
266</div></td>
267</tr></table>
268<hr>
269<div class="spirit-nav">
270<a accesskey="p" href="dynamic_buffer/overload4.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="dynamic_string_buffer/capacity.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
271</div>
272</body>
273</html>
274