libs/beast/doc/html/beast/ref/boost__beast__ostream.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ostream</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__operator_gt__eq_/overload3.html" title="operator&gt;= (3 of 3 overloads)">
  10 <link rel="next" href="boost__beast__rate_policy_access.html" title="rate_policy_access">
  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__operator_gt__eq_/overload3.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__rate_policy_access.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__ostream"></a><a class="link" href="boost__beast__ostream.html" title="ostream">ostream</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873485705232"></a>
  31 Return an output stream that formats values into a <span class="emphasis"><em>DynamicBuffer</em></span>.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__ostream.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__ostream.synopsis"></a></span><a class="link" href="boost__beast__ostream.html#beast.ref.boost__beast__ostream.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/ostream.hpp" target="_top">boost/beast/core/ostream.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/DynamicBuffer.html" title="DynamicBuffer"><span class="emphasis"><em>DynamicBuffer</em></span></a><span class="special">&gt;</span>
  42 <span class="emphasis"><em>implementation-defined</em></span>
  43 <span class="identifier">ostream</span><span class="special">(</span>
  44     <span class="identifier">DynamicBuffer</span><span class="special">&amp;</span> <span class="identifier">buffer</span><span class="special">);</span>
  45 </pre>
  46 <h5>
  47 <a name="beast.ref.boost__beast__ostream.h1"></a>
  48         <span class="phrase"><a name="beast.ref.boost__beast__ostream.description"></a></span><a class="link" href="boost__beast__ostream.html#beast.ref.boost__beast__ostream.description">Description</a>
  49       </h5>
  50 <p>
  51         This function wraps the caller provided <span class="emphasis"><em>DynamicBuffer</em></span>
  52         into a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span></code> derived class, to allow <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></code>
  53         stream style formatting operations.
  54       </p>
  55 <h5>
  56 <a name="beast.ref.boost__beast__ostream.h2"></a>
  57         <span class="phrase"><a name="beast.ref.boost__beast__ostream.example"></a></span><a class="link" href="boost__beast__ostream.html#beast.ref.boost__beast__ostream.example">Example</a>
  58       </h5>
  59 <pre class="programlisting"><span class="identifier">ostream</span><span class="special">(</span><span class="identifier">buffer</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="string">"Hello, world!"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
  60 </pre>
  61 <h5>
  62 <a name="beast.ref.boost__beast__ostream.h3"></a>
  63         <span class="phrase"><a name="beast.ref.boost__beast__ostream.remarks"></a></span><a class="link" href="boost__beast__ostream.html#beast.ref.boost__beast__ostream.remarks">Remarks</a>
  64       </h5>
  65 <p>
  66         Calling members of the underlying buffer before the output stream is destroyed
  67         results in undefined behavior.
  68       </p>
  69 <h5>
  70 <a name="beast.ref.boost__beast__ostream.h4"></a>
  71         <span class="phrase"><a name="beast.ref.boost__beast__ostream.parameters"></a></span><a class="link" href="boost__beast__ostream.html#beast.ref.boost__beast__ostream.parameters">Parameters</a>
  72       </h5>
  73 <div class="informaltable"><table class="table">
  74 <colgroup>
  75 <col>
  76 <col>
  77 </colgroup>
  78 <thead><tr>
  79 <th>
  80                 <p>
  81                   Name
  82                 </p>
  83               </th>
  84 <th>
  85                 <p>
  86                   Description
  87                 </p>
  88               </th>
  89 </tr></thead>
  90 <tbody><tr>
  91 <td>
  92                 <p>
  93                   <code class="computeroutput"><span class="identifier">buffer</span></code>
  94                 </p>
  95               </td>
  96 <td>
  97                 <p>
  98                   An object meeting the requirements of <span class="emphasis"><em>DynamicBuffer</em></span>
  99                   into which the formatted output will be placed.
 100                 </p>
 101               </td>
 102 </tr></tbody>
 103 </table></div>
 104 <h5>
 105 <a name="beast.ref.boost__beast__ostream.h5"></a>
 106         <span class="phrase"><a name="beast.ref.boost__beast__ostream.return_value"></a></span><a class="link" href="boost__beast__ostream.html#beast.ref.boost__beast__ostream.return_value">Return
 107         Value</a>
 108       </h5>
 109 <p>
 110         An object derived from <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span></code>
 111         which redirects output The wrapped dynamic buffer is not modified, a copy
 112         is made instead. Ownership of the underlying memory is not transferred, the
 113         application is still responsible for managing its lifetime. The caller is
 114         responsible for ensuring the dynamic buffer is not destroyed for the lifetime
 115         of the output stream.
 116       </p>
 117 <p>
 118         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
 119       </p>
 120 </div>
 121 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 122 <td align="left"></td>
 123 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 124       Falco<p>
 125         Distributed under the Boost Software License, Version 1.0. (See accompanying
 126         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>)
 127       </p>
 128 </div></td>
 129 </tr></table>
 130 <hr>
 131 <div class="spirit-nav">
 132 <a accesskey="p" href="boost__beast__operator_gt__eq_/overload3.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__rate_policy_access.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 133 </div>
 134 </body>
 135 </html>