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