libs/log/doc/html/boost/log/basic_formatter.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_formatter</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.Log v2">
   8 <link rel="up" href="../../expressions.html#header.boost.log.expressions.formatter_hpp" title="Header &lt;boost/log/expressions/formatter.hpp&gt;">
   9 <link rel="prev" href="swap_idm45711349524992.html" title="Function swap">
  10 <link rel="next" href="swap_idm45711349487712.html" title="Function template swap">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="swap_idm45711349524992.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../expressions.html#header.boost.log.expressions.formatter_hpp"><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="swap_idm45711349487712.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.basic_formatter"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template basic_formatter</span></h2>
  22 <p>boost::log::basic_formatter</p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../expressions.html#header.boost.log.expressions.formatter_hpp" title="Header &lt;boost/log/expressions/formatter.hpp&gt;">boost/log/expressions/formatter.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// types</span>
  31   <span class="keyword">typedef</span> <span class="keyword">void</span>                                  <a name="boost.log.basic_formatter.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>  <span class="comment">// Result type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                                 <a name="boost.log.basic_formatter.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>    <span class="comment">// Character type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">basic_formatting_ostream</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.basic_formatter.stream_type"></a><span class="identifier">stream_type</span><span class="special">;</span>  <span class="comment">// Output stream type. </span>
  34
  35   <span class="comment">// <a class="link" href="basic_formatter.html#boost.log.basic_formatterconstruct-copy-destruct">construct/copy/destruct</a></span>
  36   <a class="link" href="basic_formatter.html#idm45711349505264-bb"><span class="identifier">basic_formatter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  37   <a class="link" href="basic_formatter.html#idm45711349504496-bb"><span class="identifier">basic_formatter</span></a><span class="special">(</span><a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  38   <a class="link" href="basic_formatter.html#idm45711349502816-bb"><span class="identifier">basic_formatter</span></a><span class="special">(</span>this_type <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  39   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <a class="link" href="basic_formatter.html#idm45711349500800-bb"><span class="identifier">basic_formatter</span></a><span class="special">(</span><span class="identifier">FunT</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">&amp;</span> <a class="link" href="basic_formatter.html#idm45711349498480-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span>this_type <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  41   <a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">&amp;</span> <a class="link" href="basic_formatter.html#idm45711349495888-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">&amp;</span> <a class="link" href="basic_formatter.html#idm45711349493632-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">FunT</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="basic_formatter.html#idm45711349513840-bb">public member functions</a></span>
  45   <span class="identifier">result_type</span> <a class="link" href="basic_formatter.html#idm45711349513280-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">stream_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  46   <span class="keyword">void</span> <a class="link" href="basic_formatter.html#idm45711349509264-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">void</span> <a class="link" href="basic_formatter.html#idm45711349507936-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="idm45554747427568"></a><h2>Description</h2>
  51 <p>Log record formatter function wrapper. </p>
  52 <div class="refsect2">
  53 <a name="idm45554747426896"></a><h3>
  54 <a name="boost.log.basic_formatterconstruct-copy-destruct"></a><code class="computeroutput">basic_formatter</code>
  55         public
  56        construct/copy/destruct</h3>
  57 <div class="orderedlist"><ol class="orderedlist" type="1">
  58 <li class="listitem">
  59 <pre class="literallayout"><a name="idm45711349505264-bb"></a><span class="identifier">basic_formatter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  60 <p>Default constructor. Creates a formatter that only outputs log message. </p>
  61 </li>
  62 <li class="listitem">
  63 <pre class="literallayout"><a name="idm45711349504496-bb"></a><span class="identifier">basic_formatter</span><span class="special">(</span><a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  64 <p>Copy constructor </p>
  65 </li>
  66 <li class="listitem">
  67 <pre class="literallayout"><a name="idm45711349502816-bb"></a><span class="identifier">basic_formatter</span><span class="special">(</span>this_type <span class="special">&amp;&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  68 <p>Move constructor. The moved-from formatter is left in an unspecified state. </p>
  69 </li>
  70 <li class="listitem">
  71 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <a name="idm45711349500800-bb"></a><span class="identifier">basic_formatter</span><span class="special">(</span><span class="identifier">FunT</span> <span class="special">&amp;&amp;</span> fun<span class="special">)</span><span class="special">;</span></pre>
  72 <p>Initializing constructor. Creates a formatter which will invoke the specified function object. </p>
  73 </li>
  74 <li class="listitem">
  75 <pre class="literallayout"><a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">&amp;</span> <a name="idm45711349498480-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span>this_type <span class="special">&amp;&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  76 <p>Move assignment. The moved-from formatter is left in an unspecified state. </p>
  77 </li>
  78 <li class="listitem">
  79 <pre class="literallayout"><a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">&amp;</span> <a name="idm45711349495888-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  80 <p>Copy assignment. </p>
  81 </li>
  82 <li class="listitem">
  83 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">&amp;</span> <a name="idm45711349493632-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">FunT</span> <span class="special">&amp;&amp;</span> fun<span class="special">)</span><span class="special">;</span></pre>
  84 <p>Initializing assignment. Sets the specified function object to the formatter. </p>
  85 </li>
  86 </ol></div>
  87 </div>
  88 <div class="refsect2">
  89 <a name="idm45554747375904"></a><h3>
  90 <a name="idm45711349513840-bb"></a><code class="computeroutput">basic_formatter</code> public member functions</h3>
  91 <div class="orderedlist"><ol class="orderedlist" type="1">
  92 <li class="listitem">
  93 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45711349513280-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span> rec<span class="special">,</span> <span class="identifier">stream_type</span> <span class="special">&amp;</span> strm<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  94 <p>Formatting operator.</p>
  95 <p>
  96 </p>
  97 <div class="variablelist"><table border="0" class="variablelist compact">
  98 <colgroup>
  99 <col align="left" valign="top">
 100 <col>
 101 </colgroup>
 102 <tbody><tr>
 103 <td><p><span class="term">Parameters:</span></p></td>
 104 <td><div class="variablelist"><table border="0" class="variablelist compact">
 105 <colgroup>
 106 <col align="left" valign="top">
 107 <col>
 108 </colgroup>
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term"><code class="computeroutput">rec</code></span></p></td>
 112 <td><p>A log record to format. </p></td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term"><code class="computeroutput">strm</code></span></p></td>
 116 <td><p>A stream to put the formatted characters to. </p></td>
 117 </tr>
 118 </tbody>
 119 </table></div></td>
 120 </tr></tbody>
 121 </table></div>
 122 </li>
 123 <li class="listitem">
 124 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711349509264-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 125 <p>Resets the formatter to the default. The default formatter only outputs message text. </p>
 126 </li>
 127 <li class="listitem">
 128 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711349507936-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 129 <p>Swaps two formatters </p>
 130 </li>
 131 </ol></div>
 132 </div>
 133 </div>
 134 </div>
 135 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 136 <td align="left"></td>
 137 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 138         Distributed under the Boost Software License, Version 1.0. (See accompanying
 139         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>).
 140       </p>
 141 </div></td>
 142 </tr></table>
 143 <hr>
 144 <div class="spirit-nav">
 145 <a accesskey="p" href="swap_idm45711349524992.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../expressions.html#header.boost.log.expressions.formatter_hpp"><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="swap_idm45711349487712.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 146 </div>
 147 </body>
 148 </html>