1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>buffers_iterator</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="buffers_end.html" title="buffers_end"> 10<link rel="next" href="buffers_iterator/begin.html" title="buffers_iterator::begin"> 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="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> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.buffers_iterator"></a><a class="link" href="buffers_iterator.html" title="buffers_iterator">buffers_iterator</a> 28</h3></div></div></div> 29<p> 30 A random access iterator over the bytes in a buffer sequence. 31 </p> 32<pre class="programlisting">template< 33 typename BufferSequence, 34 typename ByteType = char> 35class buffers_iterator 36</pre> 37<h5> 38<a name="boost_asio.reference.buffers_iterator.h0"></a> 39 <span class="phrase"><a name="boost_asio.reference.buffers_iterator.types"></a></span><a class="link" href="buffers_iterator.html#boost_asio.reference.buffers_iterator.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="buffers_iterator/difference_type.html" title="buffers_iterator::difference_type"><span class="bold"><strong>difference_type</strong></span></a> 63 </p> 64 </td> 65<td> 66 <p> 67 The type used for the distance between two iterators. 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <a class="link" href="buffers_iterator/iterator_category.html" title="buffers_iterator::iterator_category"><span class="bold"><strong>iterator_category</strong></span></a> 75 </p> 76 </td> 77<td> 78 <p> 79 The iterator category. 80 </p> 81 </td> 82</tr> 83<tr> 84<td> 85 <p> 86 <a class="link" href="buffers_iterator/pointer.html" title="buffers_iterator::pointer"><span class="bold"><strong>pointer</strong></span></a> 87 </p> 88 </td> 89<td> 90 <p> 91 The type of the result of applying operator->() to the iterator. 92 </p> 93 </td> 94</tr> 95<tr> 96<td> 97 <p> 98 <a class="link" href="buffers_iterator/reference.html" title="buffers_iterator::reference"><span class="bold"><strong>reference</strong></span></a> 99 </p> 100 </td> 101<td> 102 <p> 103 The type of the result of applying operator*() to the iterator. 104 </p> 105 </td> 106</tr> 107<tr> 108<td> 109 <p> 110 <a class="link" href="buffers_iterator/value_type.html" title="buffers_iterator::value_type"><span class="bold"><strong>value_type</strong></span></a> 111 </p> 112 </td> 113<td> 114 <p> 115 The type of the value pointed to by the iterator. 116 </p> 117 </td> 118</tr> 119</tbody> 120</table></div> 121<h5> 122<a name="boost_asio.reference.buffers_iterator.h1"></a> 123 <span class="phrase"><a name="boost_asio.reference.buffers_iterator.member_functions"></a></span><a class="link" href="buffers_iterator.html#boost_asio.reference.buffers_iterator.member_functions">Member Functions</a> 124 </h5> 125<div class="informaltable"><table class="table"> 126<colgroup> 127<col> 128<col> 129</colgroup> 130<thead><tr> 131<th> 132 <p> 133 Name 134 </p> 135 </th> 136<th> 137 <p> 138 Description 139 </p> 140 </th> 141</tr></thead> 142<tbody> 143<tr> 144<td> 145 <p> 146 <a class="link" href="buffers_iterator/begin.html" title="buffers_iterator::begin"><span class="bold"><strong>begin</strong></span></a> <span class="silver">[static]</span> 147 </p> 148 </td> 149<td> 150 <p> 151 Construct an iterator representing the beginning of the buffers' 152 data. 153 </p> 154 </td> 155</tr> 156<tr> 157<td> 158 <p> 159 <a class="link" href="buffers_iterator/buffers_iterator.html" title="buffers_iterator::buffers_iterator"><span class="bold"><strong>buffers_iterator</strong></span></a> <span class="silver">[constructor]</span> 160 </p> 161 </td> 162<td> 163 <p> 164 Default constructor. Creates an iterator in an undefined state. 165 </p> 166 </td> 167</tr> 168<tr> 169<td> 170 <p> 171 <a class="link" href="buffers_iterator/end.html" title="buffers_iterator::end"><span class="bold"><strong>end</strong></span></a> <span class="silver">[static]</span> 172 </p> 173 </td> 174<td> 175 <p> 176 Construct an iterator representing the end of the buffers' data. 177 </p> 178 </td> 179</tr> 180<tr> 181<td> 182 <p> 183 <a class="link" href="buffers_iterator/operator__star_.html" title="buffers_iterator::operator *"><span class="bold"><strong>operator *</strong></span></a> 184 </p> 185 </td> 186<td> 187 <p> 188 Dereference an iterator. 189 </p> 190 </td> 191</tr> 192<tr> 193<td> 194 <p> 195 <a class="link" href="buffers_iterator/operator_plus__plus_.html" title="buffers_iterator::operator++"><span class="bold"><strong>operator++</strong></span></a> 196 </p> 197 </td> 198<td> 199 <p> 200 Increment operator (prefix). <br> <span class="silver"> —</span><br> Increment operator (postfix). 201 </p> 202 </td> 203</tr> 204<tr> 205<td> 206 <p> 207 <a class="link" href="buffers_iterator/operator_plus__eq_.html" title="buffers_iterator::operator+="><span class="bold"><strong>operator+=</strong></span></a> 208 </p> 209 </td> 210<td> 211 <p> 212 Addition operator. 213 </p> 214 </td> 215</tr> 216<tr> 217<td> 218 <p> 219 <a class="link" href="buffers_iterator/operator_minus__minus_.html" title="buffers_iterator::operator--"><span class="bold"><strong>operator--</strong></span></a> 220 </p> 221 </td> 222<td> 223 <p> 224 Decrement operator (prefix). <br> <span class="silver"> —</span><br> Decrement operator (postfix). 225 </p> 226 </td> 227</tr> 228<tr> 229<td> 230 <p> 231 <a class="link" href="buffers_iterator/operator_minus__eq_.html" title="buffers_iterator::operator-="><span class="bold"><strong>operator-=</strong></span></a> 232 </p> 233 </td> 234<td> 235 <p> 236 Subtraction operator. 237 </p> 238 </td> 239</tr> 240<tr> 241<td> 242 <p> 243 <a class="link" href="buffers_iterator/operator_arrow_.html" title="buffers_iterator::operator->"><span class="bold"><strong>operator-></strong></span></a> 244 </p> 245 </td> 246<td> 247 <p> 248 Dereference an iterator. 249 </p> 250 </td> 251</tr> 252<tr> 253<td> 254 <p> 255 <a class="link" href="buffers_iterator/operator_lb__rb_.html" title="buffers_iterator::operator[]"><span class="bold"><strong>operator[]</strong></span></a> 256 </p> 257 </td> 258<td> 259 <p> 260 Access an individual element. 261 </p> 262 </td> 263</tr> 264</tbody> 265</table></div> 266<h5> 267<a name="boost_asio.reference.buffers_iterator.h2"></a> 268 <span class="phrase"><a name="boost_asio.reference.buffers_iterator.friends"></a></span><a class="link" href="buffers_iterator.html#boost_asio.reference.buffers_iterator.friends">Friends</a> 269 </h5> 270<div class="informaltable"><table class="table"> 271<colgroup> 272<col> 273<col> 274</colgroup> 275<thead><tr> 276<th> 277 <p> 278 Name 279 </p> 280 </th> 281<th> 282 <p> 283 Description 284 </p> 285 </th> 286</tr></thead> 287<tbody> 288<tr> 289<td> 290 <p> 291 <a class="link" href="buffers_iterator/operator_not__eq_.html" title="buffers_iterator::operator!="><span class="bold"><strong>operator!=</strong></span></a> 292 </p> 293 </td> 294<td> 295 <p> 296 Test two iterators for inequality. 297 </p> 298 </td> 299</tr> 300<tr> 301<td> 302 <p> 303 <a class="link" href="buffers_iterator/operator_plus_.html" title="buffers_iterator::operator+"><span class="bold"><strong>operator+</strong></span></a> 304 </p> 305 </td> 306<td> 307 <p> 308 Addition operator. 309 </p> 310 </td> 311</tr> 312<tr> 313<td> 314 <p> 315 <a class="link" href="buffers_iterator/operator_minus_.html" title="buffers_iterator::operator-"><span class="bold"><strong>operator-</strong></span></a> 316 </p> 317 </td> 318<td> 319 <p> 320 Subtraction operator. 321 </p> 322 </td> 323</tr> 324<tr> 325<td> 326 <p> 327 <a class="link" href="buffers_iterator/operator_lt_.html" title="buffers_iterator::operator<"><span class="bold"><strong>operator<</strong></span></a> 328 </p> 329 </td> 330<td> 331 <p> 332 Compare two iterators. 333 </p> 334 </td> 335</tr> 336<tr> 337<td> 338 <p> 339 <a class="link" href="buffers_iterator/operator_lt__eq_.html" title="buffers_iterator::operator<="><span class="bold"><strong>operator<=</strong></span></a> 340 </p> 341 </td> 342<td> 343 <p> 344 Compare two iterators. 345 </p> 346 </td> 347</tr> 348<tr> 349<td> 350 <p> 351 <a class="link" href="buffers_iterator/operator_eq__eq_.html" title="buffers_iterator::operator=="><span class="bold"><strong>operator==</strong></span></a> 352 </p> 353 </td> 354<td> 355 <p> 356 Test two iterators for equality. 357 </p> 358 </td> 359</tr> 360<tr> 361<td> 362 <p> 363 <a class="link" href="buffers_iterator/operator_gt_.html" title="buffers_iterator::operator>"><span class="bold"><strong>operator></strong></span></a> 364 </p> 365 </td> 366<td> 367 <p> 368 Compare two iterators. 369 </p> 370 </td> 371</tr> 372<tr> 373<td> 374 <p> 375 <a class="link" href="buffers_iterator/operator_gt__eq_.html" title="buffers_iterator::operator>="><span class="bold"><strong>operator>=</strong></span></a> 376 </p> 377 </td> 378<td> 379 <p> 380 Compare two iterators. 381 </p> 382 </td> 383</tr> 384</tbody> 385</table></div> 386<h5> 387<a name="boost_asio.reference.buffers_iterator.h3"></a> 388 <span class="phrase"><a name="boost_asio.reference.buffers_iterator.requirements"></a></span><a class="link" href="buffers_iterator.html#boost_asio.reference.buffers_iterator.requirements">Requirements</a> 389 </h5> 390<p> 391 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/buffers_iterator.hpp</code> 392 </p> 393<p> 394 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 395 </p> 396</div> 397<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 398<td align="left"></td> 399<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 400 Kohlhoff<p> 401 Distributed under the Boost Software License, Version 1.0. (See accompanying 402 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>) 403 </p> 404</div></td> 405</tr></table> 406<hr> 407<div class="spirit-nav"> 408<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> 409</div> 410</body> 411</html> 412
