• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>make_printable</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__system_category.html" title="system_category">
10<link rel="next" href="boost__beast__ostream.html" title="ostream">
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__system_category.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__ostream.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__make_printable"></a><a class="link" href="boost__beast__make_printable.html" title="make_printable">make_printable</a>
28</h4></div></div></div>
29<p>
30        <a class="indexterm" name="idm46057512771168"></a>
31      </p>
32<p>
33        Helper to permit a buffer sequence to be printed to a std::ostream.
34      </p>
35<h5>
36<a name="beast.ref.boost__beast__make_printable.h0"></a>
37        <span class="phrase"><a name="beast.ref.boost__beast__make_printable.synopsis"></a></span><a class="link" href="boost__beast__make_printable.html#beast.ref.boost__beast__make_printable.synopsis">Synopsis</a>
38      </h5>
39<p>
40        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/make_printable.hpp" target="_top">boost/beast/core/make_printable.hpp</a>&gt;</code>
41      </p>
42<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
43    <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/ConstBufferSequence.html" target="_top"><span class="emphasis"><em>ConstBufferSequence</em></span></a><span class="special">&gt;</span>
44<span class="emphasis"><em>implementation-defined</em></span>
45<span class="identifier">make_printable</span><span class="special">(</span>
46    <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">);</span>
47</pre>
48<h5>
49<a name="beast.ref.boost__beast__make_printable.h1"></a>
50        <span class="phrase"><a name="beast.ref.boost__beast__make_printable.description"></a></span><a class="link" href="boost__beast__make_printable.html#beast.ref.boost__beast__make_printable.description">Description</a>
51      </h5>
52<p>
53        This function is used to wrap a buffer sequence to allow it to be interpreted
54        as characters and written to a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span></code>
55        such as <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span></code>. No character translation is performed;
56        unprintable and null characters will be transferred as-is to the output stream.
57      </p>
58<h5>
59<a name="beast.ref.boost__beast__make_printable.h2"></a>
60        <span class="phrase"><a name="beast.ref.boost__beast__make_printable.example"></a></span><a class="link" href="boost__beast__make_printable.html#beast.ref.boost__beast__make_printable.example">Example</a>
61      </h5>
62<p>
63        This function prints the size and contents of a buffer sequence to standard
64        output:
65      </p>
66<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ConstBufferSequence</span><span class="special">&gt;</span>
67<span class="keyword">void</span>
68<span class="identifier">print</span> <span class="special">(</span><span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">)</span>
69<span class="special">{</span>
70    <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span>
71        <span class="string">"Buffer size: "</span> <span class="special">&lt;&lt;</span> <span class="identifier">buffer_bytes</span><span class="special">(</span><span class="identifier">buffers</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="string">" bytes\n"</span>
72        <span class="string">"Buffer data: '"</span> <span class="special">&lt;&lt;</span> <span class="identifier">make_printable</span><span class="special">(</span><span class="identifier">buffers</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="string">"'\n"</span><span class="special">;</span>
73<span class="special">}</span>
74</pre>
75<h5>
76<a name="beast.ref.boost__beast__make_printable.h3"></a>
77        <span class="phrase"><a name="beast.ref.boost__beast__make_printable.parameters"></a></span><a class="link" href="boost__beast__make_printable.html#beast.ref.boost__beast__make_printable.parameters">Parameters</a>
78      </h5>
79<div class="informaltable"><table class="table">
80<colgroup>
81<col>
82<col>
83</colgroup>
84<thead><tr>
85<th>
86                <p>
87                  Name
88                </p>
89              </th>
90<th>
91                <p>
92                  Description
93                </p>
94              </th>
95</tr></thead>
96<tbody><tr>
97<td>
98                <p>
99                  <code class="computeroutput"><span class="identifier">buffers</span></code>
100                </p>
101              </td>
102<td>
103                <p>
104                  An object meeting the requirements of <span class="emphasis"><em>ConstBufferSequence</em></span>
105                  to be streamed. The implementation will make a copy of this object.
106                  Ownership of the underlying memory is not transferred, the application
107                  is still responsible for managing its lifetime.
108                </p>
109              </td>
110</tr></tbody>
111</table></div>
112</div>
113<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
114<td align="left"></td>
115<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
116      Falco<p>
117        Distributed under the Boost Software License, Version 1.0. (See accompanying
118        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>)
119      </p>
120</div></td>
121</tr></table>
122<hr>
123<div class="spirit-nav">
124<a accesskey="p" href="boost__beast__system_category.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__ostream.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
125</div>
126</body>
127</html>
128