libs/beast/doc/html/beast/ref/boost__beast__buffers_front.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>buffers_front</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_cat_view/value_type.html" title="buffers_cat_view::value_type">
  10 <link rel="next" href="boost__beast__buffers_iterator_type.html" title="buffers_iterator_type">
  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_cat_view/value_type.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_iterator_type.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_front"></a><a class="link" href="boost__beast__buffers_front.html" title="buffers_front">buffers_front</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873512416016"></a>
  31 Returns the first buffer in a buffer sequence.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__buffers_front.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__buffers_front.synopsis"></a></span><a class="link" href="boost__beast__buffers_front.html#beast.ref.boost__beast__buffers_front.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/buffers_prefix.hpp" target="_top">boost/beast/core/buffers_prefix.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="identifier">buffers_type</span><span class="special">&lt;</span> <span class="identifier">BufferSequence</span> <span class="special">&gt;</span>
  43 <span class="identifier">buffers_front</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_front.h1"></a>
  48         <span class="phrase"><a name="beast.ref.boost__beast__buffers_front.description"></a></span><a class="link" href="boost__beast__buffers_front.html#beast.ref.boost__beast__buffers_front.description">Description</a>
  49       </h5>
  50 <p>
  51         This returns the first buffer in the buffer sequence. If the buffer sequence
  52         is an empty range, the returned buffer will have a zero buffer size.
  53       </p>
  54 <h5>
  55 <a name="beast.ref.boost__beast__buffers_front.h2"></a>
  56         <span class="phrase"><a name="beast.ref.boost__beast__buffers_front.parameters"></a></span><a class="link" href="boost__beast__buffers_front.html#beast.ref.boost__beast__buffers_front.parameters">Parameters</a>
  57       </h5>
  58 <div class="informaltable"><table class="table">
  59 <colgroup>
  60 <col>
  61 <col>
  62 </colgroup>
  63 <thead><tr>
  64 <th>
  65                 <p>
  66                   Name
  67                 </p>
  68               </th>
  69 <th>
  70                 <p>
  71                   Description
  72                 </p>
  73               </th>
  74 </tr></thead>
  75 <tbody><tr>
  76 <td>
  77                 <p>
  78                   <code class="computeroutput"><span class="identifier">buffers</span></code>
  79                 </p>
  80               </td>
  81 <td>
  82                 <p>
  83                   The buffer sequence. If the sequence is mutable, the returned buffer
  84                   sequence will also be mutable. Otherwise, the returned buffer sequence
  85                   will be constant.
  86                 </p>
  87               </td>
  88 </tr></tbody>
  89 </table></div>
  90 <p>
  91         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
  92       </p>
  93 </div>
  94 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  95 <td align="left"></td>
  96 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  97       Falco<p>
  98         Distributed under the Boost Software License, Version 1.0. (See accompanying
  99         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>)
 100       </p>
 101 </div></td>
 102 </tr></table>
 103 <hr>
 104 <div class="spirit-nav">
 105 <a accesskey="p" href="boost__beast__buffers_cat_view/value_type.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_iterator_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 106 </div>
 107 </body>
 108 </html>