• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_streambuf_ref</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="basic_streambuf/underflow.html" title="basic_streambuf::underflow">
10<link rel="next" href="basic_streambuf_ref/basic_streambuf_ref.html" title="basic_streambuf_ref::basic_streambuf_ref">
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="basic_streambuf/underflow.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="basic_streambuf_ref/basic_streambuf_ref.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.basic_streambuf_ref"></a><a class="link" href="basic_streambuf_ref.html" title="basic_streambuf_ref">basic_streambuf_ref</a>
28</h3></div></div></div>
29<p>
30        Adapts <a class="link" href="basic_streambuf.html" title="basic_streambuf"><code class="computeroutput">basic_streambuf</code></a>
31        to the dynamic buffer sequence type requirements.
32      </p>
33<pre class="programlisting">template&lt;
34    typename Allocator = std::allocator&lt;char&gt;&gt;
35class basic_streambuf_ref
36</pre>
37<h5>
38<a name="boost_asio.reference.basic_streambuf_ref.h0"></a>
39        <span class="phrase"><a name="boost_asio.reference.basic_streambuf_ref.types"></a></span><a class="link" href="basic_streambuf_ref.html#boost_asio.reference.basic_streambuf_ref.types">Types</a>
40      </h5>
41<div class="informaltable"><table class="table">
42<colgroup>
43<col>
44<col>
45</colgroup>
46<thead><tr>
47<th>
48                <p>
49                  Name
50                </p>
51              </th>
52<th>
53                <p>
54                  Description
55                </p>
56              </th>
57</tr></thead>
58<tbody>
59<tr>
60<td>
61                <p>
62                  <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>
63                </p>
64              </td>
65<td>
66                <p>
67                  The type used to represent the input sequence as a list of buffers.
68                </p>
69              </td>
70</tr>
71<tr>
72<td>
73                <p>
74                  <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>
75                </p>
76              </td>
77<td>
78                <p>
79                  The type used to represent the output sequence as a list of buffers.
80                </p>
81              </td>
82</tr>
83</tbody>
84</table></div>
85<h5>
86<a name="boost_asio.reference.basic_streambuf_ref.h1"></a>
87        <span class="phrase"><a name="boost_asio.reference.basic_streambuf_ref.member_functions"></a></span><a class="link" href="basic_streambuf_ref.html#boost_asio.reference.basic_streambuf_ref.member_functions">Member
88        Functions</a>
89      </h5>
90<div class="informaltable"><table class="table">
91<colgroup>
92<col>
93<col>
94</colgroup>
95<thead><tr>
96<th>
97                <p>
98                  Name
99                </p>
100              </th>
101<th>
102                <p>
103                  Description
104                </p>
105              </th>
106</tr></thead>
107<tbody>
108<tr>
109<td>
110                <p>
111                  <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>
112                </p>
113              </td>
114<td>
115                <p>
116                  Construct a basic_streambuf_ref for the given basic_streambuf object.
117                  <br> <span class="silver"> —</span><br> Copy construct a basic_streambuf_ref. <br> <span class="silver"> —</span><br>
118                  Move construct a basic_streambuf_ref.
119                </p>
120              </td>
121</tr>
122<tr>
123<td>
124                <p>
125                  <a class="link" href="basic_streambuf_ref/capacity.html" title="basic_streambuf_ref::capacity"><span class="bold"><strong>capacity</strong></span></a>
126                </p>
127              </td>
128<td>
129                <p>
130                  Get the current capacity of the dynamic buffer.
131                </p>
132              </td>
133</tr>
134<tr>
135<td>
136                <p>
137                  <a class="link" href="basic_streambuf_ref/commit.html" title="basic_streambuf_ref::commit"><span class="bold"><strong>commit</strong></span></a>
138                </p>
139              </td>
140<td>
141                <p>
142                  Move bytes from the output sequence to the input sequence.
143                </p>
144              </td>
145</tr>
146<tr>
147<td>
148                <p>
149                  <a class="link" href="basic_streambuf_ref/consume.html" title="basic_streambuf_ref::consume"><span class="bold"><strong>consume</strong></span></a>
150                </p>
151              </td>
152<td>
153                <p>
154                  Remove characters from the input sequence.
155                </p>
156              </td>
157</tr>
158<tr>
159<td>
160                <p>
161                  <a class="link" href="basic_streambuf_ref/data.html" title="basic_streambuf_ref::data"><span class="bold"><strong>data</strong></span></a>
162                </p>
163              </td>
164<td>
165                <p>
166                  Get a list of buffers that represents the input sequence.
167                </p>
168              </td>
169</tr>
170<tr>
171<td>
172                <p>
173                  <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>
174                </p>
175              </td>
176<td>
177                <p>
178                  Get the maximum size of the dynamic buffer.
179                </p>
180              </td>
181</tr>
182<tr>
183<td>
184                <p>
185                  <a class="link" href="basic_streambuf_ref/prepare.html" title="basic_streambuf_ref::prepare"><span class="bold"><strong>prepare</strong></span></a>
186                </p>
187              </td>
188<td>
189                <p>
190                  Get a list of buffers that represents the output sequence, with
191                  the given size.
192                </p>
193              </td>
194</tr>
195<tr>
196<td>
197                <p>
198                  <a class="link" href="basic_streambuf_ref/size.html" title="basic_streambuf_ref::size"><span class="bold"><strong>size</strong></span></a>
199                </p>
200              </td>
201<td>
202                <p>
203                  Get the size of the input sequence.
204                </p>
205              </td>
206</tr>
207</tbody>
208</table></div>
209<h5>
210<a name="boost_asio.reference.basic_streambuf_ref.h2"></a>
211        <span class="phrase"><a name="boost_asio.reference.basic_streambuf_ref.requirements"></a></span><a class="link" href="basic_streambuf_ref.html#boost_asio.reference.basic_streambuf_ref.requirements">Requirements</a>
212      </h5>
213<p>
214        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_streambuf.hpp</code>
215      </p>
216<p>
217        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
218      </p>
219</div>
220<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
221<td align="left"></td>
222<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
223      Kohlhoff<p>
224        Distributed under the Boost Software License, Version 1.0. (See accompanying
225        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>)
226      </p>
227</div></td>
228</tr></table>
229<hr>
230<div class="spirit-nav">
231<a accesskey="p" href="basic_streambuf/underflow.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="basic_streambuf_ref/basic_streambuf_ref.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
232</div>
233</body>
234</html>
235