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


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template basic_formatter</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
<link rel="up" href="../../expressions.html#header.boost.log.expressions.formatter_hpp" title="Header &lt;boost/log/expressions/formatter.hpp&gt;">
<link rel="prev" href="swap_idp34704784.html" title="Function swap">
<link rel="next" href="swap_idp34742064.html" title="Function template swap">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="swap_idp34704784.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_idp34742064.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.log.basic_formatter"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_formatter</span></h2>
<p>boost::log::basic_formatter</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<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;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="basic_formatter.html" title="Class template basic_formatter">basic_formatter</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <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>
  <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>
  <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>

  <span class="comment">// <a class="link" href="basic_formatter.html#boost.log.basic_formatterconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="basic_formatter.html#idp34724512-bb"><span class="identifier">basic_formatter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_formatter.html#idp34725280-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>
  <a class="link" href="basic_formatter.html#idp34726960-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>
  <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#idp34728976-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>
  <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#idp34731296-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>
  <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#idp34733888-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>
  <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#idp34736144-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>

  <span class="comment">// <a class="link" href="basic_formatter.html#idp34715936-bb">public member functions</a></span>
  <span class="identifier">result_type</span> <a class="link" href="basic_formatter.html#idp34716496-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>
  <span class="keyword">void</span> <a class="link" href="basic_formatter.html#idp34720512-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="basic_formatter.html#idp34721840-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>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp95086544"></a><h2>Description</h2>
<p>Log record formatter function wrapper. </p>
<div class="refsect2">
<a name="idp95087216"></a><h3>
<a name="boost.log.basic_formatterconstruct-copy-destruct"></a><code class="computeroutput">basic_formatter</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp34724512-bb"></a><span class="identifier">basic_formatter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Default constructor. Creates a formatter that only outputs log message. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp34725280-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>
<p>Copy constructor </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp34726960-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>
<p>Move constructor. The moved-from formatter is left in an unspecified state. </p>
</li>
<li class="listitem">
<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="idp34728976-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>
<p>Initializing constructor. Creates a formatter which will invoke the specified function object. </p>
</li>
<li class="listitem">
<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="idp34731296-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>
<p>Move assignment. The moved-from formatter is left in an unspecified state. </p>
</li>
<li class="listitem">
<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="idp34733888-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>
<p>Copy assignment. </p>
</li>
<li class="listitem">
<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="idp34736144-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>
<p>Initializing assignment. Sets the specified function object to the formatter. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp95138240"></a><h3>
<a name="idp34715936-bb"></a><code class="computeroutput">basic_formatter</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp34716496-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>
<p>Formatting operator.</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">rec</code></span></p></td>
<td><p>A log record to format. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">strm</code></span></p></td>
<td><p>A stream to put the formatted characters to. </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp34720512-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Resets the formatter to the default. The default formatter only outputs message text. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp34721840-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>
<p>Swaps two formatters </p>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2007-2014 Andrey Semashev<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>).
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="swap_idp34704784.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_idp34742064.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>