libs/beast/doc/html/beast/ref/boost__beast__make_printable.html

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