Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/basic_streambuf_ref.html

228 lines
8.8 KiB
HTML
Raw Normal View History

2023-10-24 21:59:30 -04:00
<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">
<meta name="viewport" content="width=device-width, initial-scale=1">
</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>
<a class="indexterm" name="asio.indexterm.basic_streambuf_ref"></a>
</p>
<p>
Adapts <a class="link" href="basic_streambuf.html" title="basic_streambuf"><code class="computeroutput"><span class="identifier">basic_streambuf</span></code></a>
to the dynamic buffer sequence type requirements.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">Allocator</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special">&lt;</span><span class="keyword">char</span><span class="special">&gt;&gt;</span>
<span class="keyword">class</span> <span class="identifier">basic_streambuf_ref</span>
</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>
<div class="copyright-footer">Copyright © 2003-2023 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>
<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>