ostream_string.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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. <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>
  85. <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>
  86. <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>
  87. <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>
  88. <span class="special">}</span> <span class="comment">/* boost */</span>
  89. </pre>
  90. <p>
  91. </p>
  92. <h4>
  93. <a name="ostream_string.reference.h0"></a>
  94. <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
  95. functions</a>
  96. </h4>
  97. <div class="variablelist">
  98. <p class="title"><b></b></p>
  99. <dl class="variablelist">
  100. <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>
  101. <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>
  102. <dd><div class="variablelist">
  103. <p class="title"><b></b></p>
  104. <dl class="variablelist">
  105. <dt><span class="term">Effects</span></dt>
  106. <dd><p>
  107. Behaves like a formatted inserter (as described in [ostream.formatted.reqmts])
  108. of <code class="computeroutput"><span class="identifier">os</span></code>. Creates
  109. a character sequence <code class="computeroutput"><span class="identifier">seq</span></code>
  110. of <code class="computeroutput"><span class="identifier">size</span></code> characters
  111. starting at <code class="computeroutput"><span class="identifier">data</span></code>,
  112. 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
  113. padding for <code class="computeroutput"><span class="identifier">seq</span></code>
  114. 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>.
  115. Calls <code class="computeroutput"><span class="identifier">width</span><span class="special">(</span><span class="number">0</span><span class="special">)</span></code>.
  116. </p></dd>
  117. <dt><span class="term">Returns</span></dt>
  118. <dd><p>
  119. <code class="computeroutput"><span class="identifier">os</span></code>.
  120. </p></dd>
  121. </dl>
  122. </div></dd>
  123. </dl>
  124. </div>
  125. </div>
  126. <div class="section">
  127. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  128. <a name="ostream_string.history"></a><a class="link" href="ostream_string.html#ostream_string.history" title="History">History</a>
  129. </h2></div></div></div>
  130. <h4>
  131. <a name="ostream_string.history.h0"></a>
  132. <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
  133. 1.71</a>
  134. </h4>
  135. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  136. Glen Fernandes updated the implementation of the <code class="computeroutput"><span class="identifier">basic_string_ref</span></code>
  137. and <code class="computeroutput"><span class="identifier">basic_string_view</span></code> stream
  138. insertion operators to write directly to the <code class="computeroutput"><span class="identifier">basic_streambuf</span></code>
  139. and refactored that functionality into this common utility.
  140. </li></ul></div>
  141. </div>
  142. </div>
  143. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  144. <td align="left"><p><small>Last revised: December 10, 2019 at 00:21:48 GMT</small></p></td>
  145. <td align="right"><div class="copyright-footer"></div></td>
  146. </tr></table>
  147. <hr>
  148. <div class="spirit-nav"></div>
  149. </body>
  150. </html>