basic_streambuf_ref.html
8.41 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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_streambuf_ref</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="basic_streambuf/underflow.html" title="basic_streambuf::underflow">
<link rel="next" href="basic_streambuf_ref/basic_streambuf_ref.html" title="basic_streambuf_ref::basic_streambuf_ref">
</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="basic_streambuf/underflow.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="basic_streambuf_ref/basic_streambuf_ref.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.basic_streambuf_ref"></a><a class="link" href="basic_streambuf_ref.html" title="basic_streambuf_ref">basic_streambuf_ref</a>
</h3></div></div></div>
<p>
Adapts <a class="link" href="basic_streambuf.html" title="basic_streambuf"><code class="computeroutput">basic_streambuf</code></a>
to the dynamic buffer sequence type requirements.
</p>
<pre class="programlisting">template<
typename Allocator = std::allocator<char>>
class basic_streambuf_ref
</pre>
<h5>
<a name="asio.reference.basic_streambuf_ref.h0"></a>
<span><a name="asio.reference.basic_streambuf_ref.types"></a></span><a class="link" href="basic_streambuf_ref.html#asio.reference.basic_streambuf_ref.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="basic_streambuf_ref/const_buffers_type.html" title="basic_streambuf_ref::const_buffers_type"><span class="bold"><strong>const_buffers_type</strong></span></a>
</p>
</td>
<td>
<p>
The type used to represent the input sequence as a list of buffers.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_streambuf_ref/mutable_buffers_type.html" title="basic_streambuf_ref::mutable_buffers_type"><span class="bold"><strong>mutable_buffers_type</strong></span></a>
</p>
</td>
<td>
<p>
The type used to represent the output sequence as a list of buffers.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.basic_streambuf_ref.h1"></a>
<span><a name="asio.reference.basic_streambuf_ref.member_functions"></a></span><a class="link" href="basic_streambuf_ref.html#asio.reference.basic_streambuf_ref.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="basic_streambuf_ref/basic_streambuf_ref.html" title="basic_streambuf_ref::basic_streambuf_ref"><span class="bold"><strong>basic_streambuf_ref</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Construct a basic_streambuf_ref for the given basic_streambuf object.
<br> <span class="silver"> —</span><br> Copy construct a basic_streambuf_ref. <br> <span class="silver"> —</span><br>
Move construct a basic_streambuf_ref.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_streambuf_ref/capacity.html" title="basic_streambuf_ref::capacity"><span class="bold"><strong>capacity</strong></span></a>
</p>
</td>
<td>
<p>
Get the current capacity of the dynamic buffer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_streambuf_ref/commit.html" title="basic_streambuf_ref::commit"><span class="bold"><strong>commit</strong></span></a>
</p>
</td>
<td>
<p>
Move bytes from the output sequence to the input sequence.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_streambuf_ref/consume.html" title="basic_streambuf_ref::consume"><span class="bold"><strong>consume</strong></span></a>
</p>
</td>
<td>
<p>
Remove characters from the input sequence.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_streambuf_ref/data.html" title="basic_streambuf_ref::data"><span class="bold"><strong>data</strong></span></a>
</p>
</td>
<td>
<p>
Get a list of buffers that represents the input sequence.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_streambuf_ref/max_size.html" title="basic_streambuf_ref::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="basic_streambuf_ref/prepare.html" title="basic_streambuf_ref::prepare"><span class="bold"><strong>prepare</strong></span></a>
</p>
</td>
<td>
<p>
Get a list of buffers that represents the output sequence, with
the given size.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_streambuf_ref/size.html" title="basic_streambuf_ref::size"><span class="bold"><strong>size</strong></span></a>
</p>
</td>
<td>
<p>
Get the size of the input sequence.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.basic_streambuf_ref.h2"></a>
<span><a name="asio.reference.basic_streambuf_ref.requirements"></a></span><a class="link" href="basic_streambuf_ref.html#asio.reference.basic_streambuf_ref.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_streambuf.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="basic_streambuf/underflow.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="basic_streambuf_ref/basic_streambuf_ref.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>