3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
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_handler.html" title="bind_handler">
10 <link rel="next" href="boost__beast__buffered_read_stream.html" title="buffered_read_stream">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="boost__beast__bind_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__buffered_read_stream.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
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>
30 <a class="indexterm" name="idm45873513970864"></a>
31 Return the total number of bytes in a buffer or buffer sequence.
34 <a name="beast.ref.boost__beast__buffer_bytes.h0"></a>
35 <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 Defined in header <code class="literal"><<a href="../../../../../../boost/beast/core/buffer_traits.hpp" target="_top">boost/beast/core/buffer_traits.hpp</a>></code>
40 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</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">></span>
42 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
43 <span class="identifier">buffer_bytes</span><span class="special">(</span>
44 <span class="identifier">BufferSequence</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span>
47 <a name="beast.ref.boost__beast__buffer_bytes.h1"></a>
48 <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 This function returns the total number of bytes in a buffer, buffer sequence,
52 or object convertible to a buffer. Specifically it may be passed:
54 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
56 A <span class="emphasis"><em>ConstBufferSequence</em></span> or <span class="emphasis"><em>MutableBufferSequence</em></span>
59 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 An object convertible to <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">const_buffer</span></code>
66 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>.
67 It recognizes customization points found through argument-dependent lookup.
68 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 <pre class="programlisting"><span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">net</span><span class="special">;</span>
72 <span class="identifier">buffer_bytes</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span>
75 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>;
76 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 <a name="beast.ref.boost__beast__buffer_bytes.h2"></a>
80 <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>
82 <div class="informaltable"><table class="table">
102 <code class="computeroutput"><span class="identifier">buffers</span></code>
107 The buffer or buffer sequence to calculate the size of.
113 <a name="beast.ref.boost__beast__buffer_bytes.h3"></a>
114 <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
118 The total number of bytes in the buffer or sequence.
121 Convenience header <code class="literal"><<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>></code>
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 © 2016-2019 Vinnie
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>)
134 <div class="spirit-nav">
135 <a accesskey="p" href="boost__beast__bind_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__buffered_read_stream.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>