1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>buffers_range</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="../../index.html" title="Chapter 1. Boost.Beast"> 8<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2"> 9<link rel="prev" href="boost__beast__buffers_front.html" title="buffers_front"> 10<link rel="next" href="boost__beast__buffers_range_ref.html" title="buffers_range_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="boost__beast__buffers_front.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__buffers_range_ref.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="beast.ref.boost__beast__buffers_range"></a><a class="link" href="boost__beast__buffers_range.html" title="buffers_range">buffers_range</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="idm46057513141840"></a> 31 </p> 32<p> 33 Returns an iterable range representing a buffer sequence. 34 </p> 35<h5> 36<a name="beast.ref.boost__beast__buffers_range.h0"></a> 37 <span class="phrase"><a name="beast.ref.boost__beast__buffers_range.synopsis"></a></span><a class="link" href="boost__beast__buffers_range.html#beast.ref.boost__beast__buffers_range.synopsis">Synopsis</a> 38 </h5> 39<p> 40 Defined in header <code class="literal"><<a href="../../../../../../boost/beast/core/buffers_range.hpp" target="_top">boost/beast/core/buffers_range.hpp</a>></code> 41 </p> 42<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 43 <span class="keyword">class</span> <a class="link" href="../concepts/BufferSequence.html" title="BufferSequence"><span class="emphasis"><em>BufferSequence</em></span></a><span class="special">></span> 44<span class="emphasis"><em>implementation-defined</em></span> 45<span class="identifier">buffers_range</span><span class="special">(</span> 46 <span class="identifier">BufferSequence</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> 47</pre> 48<h5> 49<a name="beast.ref.boost__beast__buffers_range.h1"></a> 50 <span class="phrase"><a name="beast.ref.boost__beast__buffers_range.description"></a></span><a class="link" href="boost__beast__buffers_range.html#beast.ref.boost__beast__buffers_range.description">Description</a> 51 </h5> 52<p> 53 This function returns an iterable range representing the passed buffer sequence. 54 The values obtained when iterating the range will be <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">const_buffer</span></code>, 55 unless the underlying buffer sequence is a <span class="emphasis"><em>MutableBufferSequence</em></span>, 56 in which case the value obtained when iterating will be a <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">mutable_buffer</span></code>. 57 </p> 58<h5> 59<a name="beast.ref.boost__beast__buffers_range.h2"></a> 60 <span class="phrase"><a name="beast.ref.boost__beast__buffers_range.example"></a></span><a class="link" href="boost__beast__buffers_range.html#beast.ref.boost__beast__buffers_range.example">Example</a> 61 </h5> 62<p> 63 The following function returns the total number of bytes in the specified 64 buffer sequence. A copy of the buffer sequence is maintained for the lifetime 65 of the range object: 66 </p> 67<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BufferSequence</span><span class="special">></span> 68<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">buffer_sequence_size</span> <span class="special">(</span><span class="identifier">BufferSequence</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">buffers</span><span class="special">)</span> 69<span class="special">{</span> 70 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> 71 <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="keyword">const</span> <span class="identifier">buffer</span> <span class="special">:</span> <span class="identifier">buffers_range</span> <span class="special">(</span><span class="identifier">buffers</span><span class="special">))</span> 72 <span class="identifier">size</span> <span class="special">+=</span> <span class="identifier">buffer</span><span class="special">.</span><span class="identifier">size</span><span class="special">();</span> 73 <span class="keyword">return</span> <span class="identifier">size</span><span class="special">;</span> 74<span class="special">}</span> 75</pre> 76<h5> 77<a name="beast.ref.boost__beast__buffers_range.h3"></a> 78 <span class="phrase"><a name="beast.ref.boost__beast__buffers_range.parameters"></a></span><a class="link" href="boost__beast__buffers_range.html#beast.ref.boost__beast__buffers_range.parameters">Parameters</a> 79 </h5> 80<div class="informaltable"><table class="table"> 81<colgroup> 82<col> 83<col> 84</colgroup> 85<thead><tr> 86<th> 87 <p> 88 Name 89 </p> 90 </th> 91<th> 92 <p> 93 Description 94 </p> 95 </th> 96</tr></thead> 97<tbody><tr> 98<td> 99 <p> 100 <code class="computeroutput"><span class="identifier">buffers</span></code> 101 </p> 102 </td> 103<td> 104 <p> 105 The buffer sequence to adapt into a range. The range object returned 106 from this function will contain a copy of the passed buffer sequence. 107 </p> 108 </td> 109</tr></tbody> 110</table></div> 111<h5> 112<a name="beast.ref.boost__beast__buffers_range.h4"></a> 113 <span class="phrase"><a name="beast.ref.boost__beast__buffers_range.return_value"></a></span><a class="link" href="boost__beast__buffers_range.html#beast.ref.boost__beast__buffers_range.return_value">Return 114 Value</a> 115 </h5> 116<p> 117 An object of unspecified type which meets the requirements of <span class="emphasis"><em>ConstBufferSequence</em></span>. 118 If <code class="computeroutput"><span class="identifier">buffers</span></code> is a mutable buffer 119 sequence, the returned object will also meet the requirements of <span class="emphasis"><em>MutableBufferSequence</em></span>. 120 </p> 121<h5> 122<a name="beast.ref.boost__beast__buffers_range.h5"></a> 123 <span class="phrase"><a name="beast.ref.boost__beast__buffers_range.see_also"></a></span><a class="link" href="boost__beast__buffers_range.html#beast.ref.boost__beast__buffers_range.see_also">See 124 Also</a> 125 </h5> 126<p> 127 <a class="link" href="boost__beast__buffers_range_ref.html" title="buffers_range_ref"><code class="computeroutput"><span class="identifier">buffers_range_ref</span></code></a> 128 </p> 129</div> 130<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 131<td align="left"></td> 132<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 133 Falco<p> 134 Distributed under the Boost Software License, Version 1.0. (See accompanying 135 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>) 136 </p> 137</div></td> 138</tr></table> 139<hr> 140<div class="spirit-nav"> 141<a accesskey="p" href="boost__beast__buffers_front.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__buffers_range_ref.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 142</div> 143</body> 144</html> 145
