libs/beast/doc/html/beast/ref/boost__beast__buffers_range_ref.html

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