libs/beast/doc/html/beast/ref/boost__beast__buffers_prefix.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>buffers_prefix</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_iterator_type.html" title="buffers_iterator_type">
  10 <link rel="next" href="boost__beast__buffers_prefix_view.html" title="buffers_prefix_view">
  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_iterator_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_prefix_view.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_prefix"></a><a class="link" href="boost__beast__buffers_prefix.html" title="buffers_prefix">buffers_prefix</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873512351360"></a>
  31 Returns a prefix of a constant or mutable buffer sequence.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__buffers_prefix.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__buffers_prefix.synopsis"></a></span><a class="link" href="boost__beast__buffers_prefix.html#beast.ref.boost__beast__buffers_prefix.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_prefix_view</span><span class="special">&lt;</span> <span class="identifier">BufferSequence</span> <span class="special">&gt;</span>
  43 <span class="identifier">buffers_prefix</span><span class="special">(</span>
  44     <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">,</span>
  45     <span class="identifier">BufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">);</span>
  46 </pre>
  47 <h5>
  48 <a name="beast.ref.boost__beast__buffers_prefix.h1"></a>
  49         <span class="phrase"><a name="beast.ref.boost__beast__buffers_prefix.description"></a></span><a class="link" href="boost__beast__buffers_prefix.html#beast.ref.boost__beast__buffers_prefix.description">Description</a>
  50       </h5>
  51 <p>
  52         The returned buffer sequence points to the same memory as the passed buffer
  53         sequence, but with a size that is equal to or smaller. No memory allocations
  54         are performed; the resulting sequence is calculated as a lazy range.
  55       </p>
  56 <h5>
  57 <a name="beast.ref.boost__beast__buffers_prefix.h2"></a>
  58         <span class="phrase"><a name="beast.ref.boost__beast__buffers_prefix.parameters"></a></span><a class="link" href="boost__beast__buffers_prefix.html#beast.ref.boost__beast__buffers_prefix.parameters">Parameters</a>
  59       </h5>
  60 <div class="informaltable"><table class="table">
  61 <colgroup>
  62 <col>
  63 <col>
  64 </colgroup>
  65 <thead><tr>
  66 <th>
  67                 <p>
  68                   Name
  69                 </p>
  70               </th>
  71 <th>
  72                 <p>
  73                   Description
  74                 </p>
  75               </th>
  76 </tr></thead>
  77 <tbody>
  78 <tr>
  79 <td>
  80                 <p>
  81                   <code class="computeroutput"><span class="identifier">size</span></code>
  82                 </p>
  83               </td>
  84 <td>
  85                 <p>
  86                   The maximum size of the returned buffer sequence in bytes. If this
  87                   is greater than or equal to the size of the passed buffer sequence,
  88                   the result will have the same size as the original buffer sequence.
  89                 </p>
  90               </td>
  91 </tr>
  92 <tr>
  93 <td>
  94                 <p>
  95                   <code class="computeroutput"><span class="identifier">buffers</span></code>
  96                 </p>
  97               </td>
  98 <td>
  99                 <p>
 100                   An object whose type meets the requirements of <span class="emphasis"><em>BufferSequence</em></span>.
 101                   The returned value will maintain a copy of the passed buffers for
 102                   its lifetime; however, ownership of the underlying memory is not
 103                   transferred.
 104                 </p>
 105               </td>
 106 </tr>
 107 </tbody>
 108 </table></div>
 109 <h5>
 110 <a name="beast.ref.boost__beast__buffers_prefix.h3"></a>
 111         <span class="phrase"><a name="beast.ref.boost__beast__buffers_prefix.return_value"></a></span><a class="link" href="boost__beast__buffers_prefix.html#beast.ref.boost__beast__buffers_prefix.return_value">Return
 112         Value</a>
 113       </h5>
 114 <p>
 115         A constant buffer sequence that represents the prefix of the original buffer
 116         sequence. If the original buffer sequence also meets the requirements of
 117         <span class="emphasis"><em>MutableBufferSequence</em></span>, then the returned value will
 118         also be a mutable buffer sequence.
 119       </p>
 120 <p>
 121         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
 122       </p>
 123 </div>
 124 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 125 <td align="left"></td>
 126 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 127       Falco<p>
 128         Distributed under the Boost Software License, Version 1.0. (See accompanying
 129         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>)
 130       </p>
 131 </div></td>
 132 </tr></table>
 133 <hr>
 134 <div class="spirit-nav">
 135 <a accesskey="p" href="boost__beast__buffers_iterator_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_prefix_view.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 136 </div>
 137 </body>
 138 </html>