blob: f9f33d7b55641f7c1bf38ddf2cd8169a8f6377de [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>buffers_iterator</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="buffers_end.html" title="buffers_end">
<link rel="next" href="buffers_iterator/begin.html" title="buffers_iterator::begin">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="buffers_end.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="buffers_iterator/begin.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.buffers_iterator"></a><a class="link" href="buffers_iterator.html" title="buffers_iterator">buffers_iterator</a>
</h3></div></div></div>
<p>
A random access iterator over the bytes in a buffer sequence.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">BufferSequence</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">ByteType</span> <span class="special">=</span> <span class="keyword">char</span><span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">buffers_iterator</span>
</pre>
<a name="boost_asio.reference.buffers_iterator.member_functions"></a><h5>
<a name="id1132031"></a>
<a class="link" href="buffers_iterator.html#boost_asio.reference.buffers_iterator.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="buffers_iterator/begin.html" title="buffers_iterator::begin"><span class="bold"><strong>begin</strong></span></a>
</p>
</td>
<td>
<p>
Construct an iterator representing the beginning of the buffers'
data.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/buffers_iterator.html" title="buffers_iterator::buffers_iterator"><span class="bold"><strong>buffers_iterator</strong></span></a>
</p>
</td>
<td>
<p>
Default constructor. Creates an iterator in an undefined state.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/end.html" title="buffers_iterator::end"><span class="bold"><strong>end</strong></span></a>
</p>
</td>
<td>
<p>
Construct an iterator representing the end of the buffers' data.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator__star_.html" title="buffers_iterator::operator *"><span class="bold"><strong>operator *</strong></span></a>
</p>
</td>
<td>
<p>
Dereference an iterator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_plus__plus_.html" title="buffers_iterator::operator++"><span class="bold"><strong>operator++</strong></span></a>
</p>
</td>
<td>
<p>
Increment operator (prefix).
</p>
<p>
Increment operator (postfix).
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_plus__eq_.html" title="buffers_iterator::operator+="><span class="bold"><strong>operator+=</strong></span></a>
</p>
</td>
<td>
<p>
Addition operator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_minus__minus_.html" title="buffers_iterator::operator--"><span class="bold"><strong>operator--</strong></span></a>
</p>
</td>
<td>
<p>
Decrement operator (prefix).
</p>
<p>
Decrement operator (postfix).
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_minus__eq_.html" title="buffers_iterator::operator-="><span class="bold"><strong>operator-=</strong></span></a>
</p>
</td>
<td>
<p>
Subtraction operator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_arrow_.html" title="buffers_iterator::operator-&gt;"><span class="bold"><strong>operator-&gt;</strong></span></a>
</p>
</td>
<td>
<p>
Dereference an iterator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_lb__rb_.html" title="buffers_iterator::operator[]"><span class="bold"><strong>operator[]</strong></span></a>
</p>
</td>
<td>
<p>
Access an individual element.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.buffers_iterator.friends"></a><h5>
<a name="id1132398"></a>
<a class="link" href="buffers_iterator.html#boost_asio.reference.buffers_iterator.friends">Friends</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="buffers_iterator/operator_not__eq_.html" title="buffers_iterator::operator!="><span class="bold"><strong>operator!=</strong></span></a>
</p>
</td>
<td>
<p>
Test two iterators for inequality.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_plus_.html" title="buffers_iterator::operator+"><span class="bold"><strong>operator+</strong></span></a>
</p>
</td>
<td>
<p>
Addition operator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_minus_.html" title="buffers_iterator::operator-"><span class="bold"><strong>operator-</strong></span></a>
</p>
</td>
<td>
<p>
Subtraction operator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_lt_.html" title="buffers_iterator::operator&lt;"><span class="bold"><strong>operator&lt;</strong></span></a>
</p>
</td>
<td>
<p>
Compare two iterators.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_lt__eq_.html" title="buffers_iterator::operator&lt;="><span class="bold"><strong>operator&lt;=</strong></span></a>
</p>
</td>
<td>
<p>
Compare two iterators.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_eq__eq_.html" title="buffers_iterator::operator=="><span class="bold"><strong>operator==</strong></span></a>
</p>
</td>
<td>
<p>
Test two iterators for equality.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_gt_.html" title="buffers_iterator::operator&gt;"><span class="bold"><strong>operator&gt;</strong></span></a>
</p>
</td>
<td>
<p>
Compare two iterators.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="buffers_iterator/operator_gt__eq_.html" title="buffers_iterator::operator&gt;="><span class="bold"><strong>operator&gt;=</strong></span></a>
</p>
</td>
<td>
<p>
Compare two iterators.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.buffers_iterator.requirements"></a><h5>
<a name="id1132694"></a>
<a class="link" href="buffers_iterator.html#boost_asio.reference.buffers_iterator.requirements">Requirements</a>
</h5>
<p>
<span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/buffers_iterator.hpp</code>
</p>
<p>
<span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/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 &#169; 2003 - 2010 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="buffers_end.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="buffers_iterator/begin.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>