libs/utility/doc/html/ostream_string.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ostream_string</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="ostream_string.html" title="ostream_string">
   8 </head>
   9 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  10 <table cellpadding="2" width="100%"><tr>
  11 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  12 <td align="center"><a href="../../../../index.html">Home</a></td>
  13 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  14 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  15 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  16 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  17 </tr></table>
  18 <hr>
  19 <div class="spirit-nav"></div>
  20 <div class="article">
  21 <div class="titlepage">
  22 <div>
  23 <div><h2 class="title">
  24 <a name="ostream_string"></a>ostream_string</h2></div>
  25 <div><div class="authorgroup"><div class="author"><h3 class="author">
  26 <span class="firstname">Glen</span> <span class="surname">Fernandes</span>
  27 </h3></div></div></div>
  28 <div><p class="copyright">Copyright &#169; 2019 Glen Joseph Fernandes</p></div>
  29 <div><div class="legalnotice">
  30 <a name="ostream_string.legal"></a><p>
  31         Distributed under the Boost Software License, Version 1.0.
  32       </p>
  33 </div></div>
  34 </div>
  35 <hr>
  36 </div>
  37 <div class="toc">
  38 <p><b>Table of Contents</b></p>
  39 <dl class="toc">
  40 <dt><span class="section"><a href="ostream_string.html#ostream_string.overview">Overview</a></span></dt>
  41 <dt><span class="section"><a href="ostream_string.html#ostream_string.examples">Examples</a></span></dt>
  42 <dt><span class="section"><a href="ostream_string.html#ostream_string.reference">Reference</a></span></dt>
  43 <dt><span class="section"><a href="ostream_string.html#ostream_string.history">History</a></span></dt>
  44 </dl>
  45 </div>
  46 <div class="section">
  47 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  48 <a name="ostream_string.overview"></a><a class="link" href="ostream_string.html#ostream_string.overview" title="Overview">Overview</a>
  49 </h2></div></div></div>
  50 <p>
  51       The header &lt;boost/utility/ostream_string.hpp&gt; provides the function template
  52       <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">ostream_string</span></code> for formatted output that
  53       satisfies the requirements of [ostream.formatted.reqmts].
  54     </p>
  55 </div>
  56 <div class="section">
  57 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  58 <a name="ostream_string.examples"></a><a class="link" href="ostream_string.html#ostream_string.examples" title="Examples">Examples</a>
  59 </h2></div></div></div>
  60 <p>
  61       The inserter for class template <code class="computeroutput"><span class="identifier">basic_string_view</span></code>
  62       could be implemented as follows:
  63     </p>
  64 <p>
  65 </p>
  66 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">charT</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">&gt;</span>
  67 <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">&gt;&amp;</span>
  68 <span class="keyword">operator</span><span class="special">&lt;&lt;(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">&gt;&amp;</span> <span class="identifier">os</span><span class="special">,</span>
  69     <span class="keyword">const</span> <span class="identifier">basic_string_view</span><span class="special">&lt;</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">&gt;&amp;</span> <span class="identifier">str</span><span class="special">)</span>
  70 <span class="special">{</span>
  71     <span class="keyword">return</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">ostream_string</span><span class="special">(</span><span class="identifier">os</span><span class="special">,</span> <span class="identifier">str</span><span class="special">.</span><span class="identifier">data</span><span class="special">(),</span> <span class="identifier">str</span><span class="special">.</span><span class="identifier">size</span><span class="special">());</span>
  72 <span class="special">}</span>
  73 </pre>
  74 <p>
  75     </p>
  76 </div>
  77 <div class="section">
  78 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  79 <a name="ostream_string.reference"></a><a class="link" href="ostream_string.html#ostream_string.reference" title="Reference">Reference</a>
  80 </h2></div></div></div>
  81 <p>
  82 </p>
  83 <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
  84
  85 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">charT</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">&gt;</span>
  86 <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">&gt;&amp;</span>
  87 <span class="identifier">ostream_string</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">&gt;&amp;</span> <span class="identifier">os</span><span class="special">,</span>
  88     <span class="keyword">const</span> <span class="identifier">charT</span><span class="special">*</span> <span class="identifier">data</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">);</span>
  89
  90 <span class="special">}</span> <span class="comment">/* boost */</span>
  91 </pre>
  92 <p>
  93     </p>
  94 <h4>
  95 <a name="ostream_string.reference.h0"></a>
  96       <span class="phrase"><a name="ostream_string.reference.free_functions"></a></span><a class="link" href="ostream_string.html#ostream_string.reference.free_functions">Free
  97       functions</a>
  98     </h4>
  99 <div class="variablelist">
 100 <p class="title"><b></b></p>
 101 <dl class="variablelist">
 102 <dt><span class="term"><code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">charT</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">&gt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">&gt;&amp;</span> <span class="identifier">ostream_string</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">&gt;&amp;</span>
 103         <span class="identifier">os</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span><span class="special">*</span> <span class="identifier">data</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">);</span></code></span></dt>
 104 <dd><div class="variablelist">
 105 <p class="title"><b></b></p>
 106 <dl class="variablelist">
 107 <dt><span class="term">Effects</span></dt>
 108 <dd><p>
 109                   Behaves like a formatted inserter (as described in [ostream.formatted.reqmts])
 110                   of <code class="computeroutput"><span class="identifier">os</span></code>. Creates
 111                   a character sequence <code class="computeroutput"><span class="identifier">seq</span></code>
 112                   of <code class="computeroutput"><span class="identifier">size</span></code> characters
 113                   starting at <code class="computeroutput"><span class="identifier">data</span></code>,
 114                   each widened using <code class="computeroutput"><span class="identifier">os</span><span class="special">.</span><span class="identifier">widen</span><span class="special">()</span></code> ([basic.ios.members]). Determines
 115                   padding for <code class="computeroutput"><span class="identifier">seq</span></code>
 116                   as described in [ostream.formatted.reqmts]. Inserts <code class="computeroutput"><span class="identifier">seq</span></code> into <code class="computeroutput"><span class="identifier">os</span></code>.
 117                   Calls <code class="computeroutput"><span class="identifier">width</span><span class="special">(</span><span class="number">0</span><span class="special">)</span></code>.
 118                 </p></dd>
 119 <dt><span class="term">Returns</span></dt>
 120 <dd><p>
 121                   <code class="computeroutput"><span class="identifier">os</span></code>.
 122                 </p></dd>
 123 </dl>
 124 </div></dd>
 125 </dl>
 126 </div>
 127 </div>
 128 <div class="section">
 129 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 130 <a name="ostream_string.history"></a><a class="link" href="ostream_string.html#ostream_string.history" title="History">History</a>
 131 </h2></div></div></div>
 132 <h4>
 133 <a name="ostream_string.history.h0"></a>
 134       <span class="phrase"><a name="ostream_string.history.boost_1_71"></a></span><a class="link" href="ostream_string.html#ostream_string.history.boost_1_71">boost
 135       1.71</a>
 136     </h4>
 137 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
 138           Glen Fernandes updated the implementation of the <code class="computeroutput"><span class="identifier">basic_string_ref</span></code>
 139           and <code class="computeroutput"><span class="identifier">basic_string_view</span></code> stream
 140           insertion operators to write directly to the <code class="computeroutput"><span class="identifier">basic_streambuf</span></code>
 141           and refactored that functionality into this common utility.
 142         </li></ul></div>
 143 </div>
 144 </div>
 145 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 146 <td align="left"><p><small>Last revised: December 10, 2019 at 00:21:48 GMT</small></p></td>
 147 <td align="right"><div class="copyright-footer"></div></td>
 148 </tr></table>
 149 <hr>
 150 <div class="spirit-nav"></div>
 151 </body>
 152 </html>