1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>buffer_bytes</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__bind_front_handler.html" title="bind_front_handler"> 10<link rel="next" href="boost__beast__buffers_cat.html" title="buffers_cat"> 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__bind_front_handler.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_cat.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__buffer_bytes"></a><a class="link" href="boost__beast__buffer_bytes.html" title="buffer_bytes">buffer_bytes</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="idm46057513325504"></a> 31 </p> 32<p> 33 Return the total number of bytes in a buffer or buffer sequence. 34 </p> 35<h5> 36<a name="beast.ref.boost__beast__buffer_bytes.h0"></a> 37 <span class="phrase"><a name="beast.ref.boost__beast__buffer_bytes.synopsis"></a></span><a class="link" href="boost__beast__buffer_bytes.html#beast.ref.boost__beast__buffer_bytes.synopsis">Synopsis</a> 38 </h5> 39<p> 40 Defined in header <code class="literal"><<a href="../../../../../../boost/beast/core/buffer_traits.hpp" target="_top">boost/beast/core/buffer_traits.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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> 45<span class="identifier">buffer_bytes</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__buffer_bytes.h1"></a> 50 <span class="phrase"><a name="beast.ref.boost__beast__buffer_bytes.description"></a></span><a class="link" href="boost__beast__buffer_bytes.html#beast.ref.boost__beast__buffer_bytes.description">Description</a> 51 </h5> 52<p> 53 This function returns the total number of bytes in a buffer, buffer sequence, 54 or object convertible to a buffer. Specifically it may be passed: 55 </p> 56<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 57<li class="listitem"> 58 A <span class="emphasis"><em>ConstBufferSequence</em></span> or <span class="emphasis"><em>MutableBufferSequence</em></span> 59 </li> 60<li class="listitem"> 61 A <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">const_buffer</span></code> or <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">mutable_buffer</span></code> 62 </li> 63<li class="listitem"> 64 An object convertible to <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">const_buffer</span></code> 65 </li> 66</ul></div> 67<p> 68 This function is designed as an easier-to-use replacement for <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">buffer_size</span></code>. 69 It recognizes customization points found through argument-dependent lookup. 70 The call <code class="computeroutput"><span class="identifier">beast</span><span class="special">::</span><span class="identifier">buffer_bytes</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code> is equivalent 71 to performing: 72 </p> 73<pre class="programlisting"><span class="keyword">using</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">buffer_size</span><span class="special">;</span> 74<span class="keyword">return</span> <span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span> 75</pre> 76<p> 77 In addition this handles types which are convertible to <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">const_buffer</span></code>; 78 these are not handled by <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">buffer_size</span></code>. 79 </p> 80<h5> 81<a name="beast.ref.boost__beast__buffer_bytes.h2"></a> 82 <span class="phrase"><a name="beast.ref.boost__beast__buffer_bytes.parameters"></a></span><a class="link" href="boost__beast__buffer_bytes.html#beast.ref.boost__beast__buffer_bytes.parameters">Parameters</a> 83 </h5> 84<div class="informaltable"><table class="table"> 85<colgroup> 86<col> 87<col> 88</colgroup> 89<thead><tr> 90<th> 91 <p> 92 Name 93 </p> 94 </th> 95<th> 96 <p> 97 Description 98 </p> 99 </th> 100</tr></thead> 101<tbody><tr> 102<td> 103 <p> 104 <code class="computeroutput"><span class="identifier">buffers</span></code> 105 </p> 106 </td> 107<td> 108 <p> 109 The buffer or buffer sequence to calculate the size of. 110 </p> 111 </td> 112</tr></tbody> 113</table></div> 114<h5> 115<a name="beast.ref.boost__beast__buffer_bytes.h3"></a> 116 <span class="phrase"><a name="beast.ref.boost__beast__buffer_bytes.return_value"></a></span><a class="link" href="boost__beast__buffer_bytes.html#beast.ref.boost__beast__buffer_bytes.return_value">Return 117 Value</a> 118 </h5> 119<p> 120 The total number of bytes in the buffer or sequence. 121 </p> 122</div> 123<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 124<td align="left"></td> 125<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 126 Falco<p> 127 Distributed under the Boost Software License, Version 1.0. (See accompanying 128 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>) 129 </p> 130</div></td> 131</tr></table> 132<hr> 133<div class="spirit-nav"> 134<a accesskey="p" href="boost__beast__bind_front_handler.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_cat.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 135</div> 136</body> 137</html> 138
