3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class record_view</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 1. Boost.Log v2">
8 <link rel="up" href="../../core_components.html#header.boost.log.core.record_view_hpp" title="Header <boost/log/core/record_view.hpp>">
9 <link rel="prev" href="swap_idm45711350433856.html" title="Function swap">
10 <link rel="next" href="swap_idm45711350374912.html" title="Function swap">
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>
15 <div class="spirit-nav">
16 <a accesskey="p" href="swap_idm45711350433856.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../core_components.html#header.boost.log.core.record_view_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_idm45711350374912.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
18 <div class="refentry">
19 <a name="boost.log.record_view"></a><div class="titlepage"></div>
20 <div class="refnamediv">
21 <h2><span class="refentrytitle">Class record_view</span></h2>
22 <p>boost::log::record_view — Logging record view class. </p>
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: <<a class="link" href="../../core_components.html#header.boost.log.core.record_view_hpp" title="Header <boost/log/core/record_view.hpp>">boost/log/core/record_view.hpp</a>>
28 <span class="keyword">class</span> <a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">{</span>
29 <span class="keyword">public</span><span class="special">:</span>
30 <span class="comment">// <a class="link" href="record_view.html#boost.log.record_viewconstruct-copy-destruct">construct/copy/destruct</a></span>
31 <a class="link" href="record_view.html#idm45711350386736-bb"><span class="identifier">record_view</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
32 <a class="link" href="record_view.html#idm45711350384800-bb"><span class="identifier">record_view</span></a><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
33 <a class="link" href="record_view.html#idm45711350382848-bb"><span class="identifier">record_view</span></a><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
34 <a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&</span> <a class="link" href="record_view.html#idm45711350380032-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
35 <a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&</span> <a class="link" href="record_view.html#idm45711350377504-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
36 <a class="link" href="record_view.html#idm45711350380832-bb"><span class="special">~</span><span class="identifier">record_view</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
38 <span class="comment">// <a class="link" href="record_view.html#idm45711350425552-bb">public member functions</a></span>
39 <span class="identifier">attribute_value_set</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="record_view.html#idm45711350424992-bb"><span class="identifier">attribute_values</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
40 <span class="keyword">bool</span> <a class="link" href="record_view.html#idm45711350421952-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
41 <span class="keyword">bool</span> <a class="link" href="record_view.html#idm45711350416480-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
42 <span class="keyword">explicit</span> <a class="link" href="record_view.html#idm45711350412400-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
43 <span class="keyword">bool</span> <a class="link" href="record_view.html#idm45711350408048-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
44 <span class="keyword">void</span> <a class="link" href="record_view.html#idm45711350403968-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
45 <span class="keyword">void</span> <a class="link" href="record_view.html#idm45711350400016-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
46 <span class="identifier">attribute_value_set</span><span class="special">::</span><span class="identifier">mapped_type</span>
47 <a class="link" href="record_view.html#idm45711350397200-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">attribute_value_set</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
48 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> DescriptorT<span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="special">></span> <span class="keyword">class</span> ActorT<span class="special">></span>
49 <span class="identifier">result_of</span><span class="special">::</span><span class="identifier">extract</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special"><</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">DescriptorT</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span>
50 <a class="link" href="record_view.html#idm45711350393184-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special"><</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
51 <span class="special">}</span><span class="special">;</span></pre></div>
52 <div class="refsect1">
53 <a name="idm45554755578352"></a><h2>Description</h2>
54 <p>The logging record encapsulates all information related to a single logging statement, in particular, attribute values view and the log message string. The view is immutable, it is implemented as a wrapper around a reference-counted implementation. </p>
55 <div class="refsect2">
56 <a name="idm45554755577408"></a><h3>
57 <a name="boost.log.record_viewconstruct-copy-destruct"></a><code class="computeroutput">record_view</code>
59 construct/copy/destruct</h3>
60 <div class="orderedlist"><ol class="orderedlist" type="1">
62 <pre class="literallayout"><a name="idm45711350386736-bb"></a><span class="identifier">record_view</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
63 <p>Default constructor. Creates an empty record view that is equivalent to the invalid record handle.</p>
66 <div class="variablelist"><table border="0" class="variablelist compact">
68 <col align="left" valign="top">
72 <td><p><span class="term">Postconditions:</span></p></td>
73 <td><p><code class="computeroutput">!*this == true</code> </p></td>
78 <pre class="literallayout"><a name="idm45711350384800-bb"></a><span class="identifier">record_view</span><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
79 <p>Copy constructor </p>
82 <pre class="literallayout"><a name="idm45711350382848-bb"></a><span class="identifier">record_view</span><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
83 <p>Move constructor. Source record contents unspecified after the operation. </p>
86 <pre class="literallayout"><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&</span> <a name="idm45711350380032-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
87 <p>Copy assignment </p>
90 <pre class="literallayout"><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&</span> <a name="idm45711350377504-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
91 <p>Move assignment. Source record contents unspecified after the operation. </p>
94 <pre class="literallayout"><a name="idm45711350380832-bb"></a><span class="special">~</span><span class="identifier">record_view</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
95 <p>Destructor. Destroys the record, releases any sinks and attribute values that were involved in processing this record. </p>
99 <div class="refsect2">
100 <a name="idm45554755534448"></a><h3>
101 <a name="idm45711350425552-bb"></a><code class="computeroutput">record_view</code> public member functions</h3>
102 <div class="orderedlist"><ol class="orderedlist" type="1">
103 <li class="listitem">
104 <pre class="literallayout"><span class="identifier">attribute_value_set</span> <span class="keyword">const</span> <span class="special">&</span> <a name="idm45711350424992-bb"></a><span class="identifier">attribute_values</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
108 <div class="variablelist"><table border="0" class="variablelist compact">
110 <col align="left" valign="top">
115 <td><p><span class="term">Requires:</span></p></td>
116 <td><p><code class="computeroutput">!!*this</code> </p></td>
119 <td><p><span class="term">Returns:</span></p></td>
120 <td><p>A reference to the set of attribute values attached to this record</p></td>
125 <li class="listitem">
126 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711350421952-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
127 <p>Equality comparison</p>
131 <div class="variablelist"><table border="0" class="variablelist compact">
133 <col align="left" valign="top">
138 <td><p><span class="term">Parameters:</span></p></td>
139 <td><div class="variablelist"><table border="0" class="variablelist compact">
141 <col align="left" valign="top">
145 <td><p><span class="term"><code class="computeroutput">that</code></span></p></td>
146 <td><p>Comparand </p></td>
151 <td><p><span class="term">Returns:</span></p></td>
152 <td><p><code class="computeroutput">true</code> if both <code class="computeroutput">*this</code> and <span class="emphasis"><em>that</em></span> identify the same log record or both do not identify any record, <code class="computeroutput">false</code> otherwise. </p></td>
157 <li class="listitem">
158 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711350416480-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
159 <p>Inequality comparison</p>
163 <div class="variablelist"><table border="0" class="variablelist compact">
165 <col align="left" valign="top">
170 <td><p><span class="term">Parameters:</span></p></td>
171 <td><div class="variablelist"><table border="0" class="variablelist compact">
173 <col align="left" valign="top">
177 <td><p><span class="term"><code class="computeroutput">that</code></span></p></td>
178 <td><p>Comparand </p></td>
183 <td><p><span class="term">Returns:</span></p></td>
184 <td><p><code class="computeroutput">!(*this == that)</code> </p></td>
189 <li class="listitem">
190 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711350412400-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
191 <p>Conversion to an unspecified boolean type</p>
194 <div class="variablelist"><table border="0" class="variablelist compact">
196 <col align="left" valign="top">
200 <td><p><span class="term">Returns:</span></p></td>
201 <td><p><code class="computeroutput">true</code>, if the <code class="computeroutput">*this</code> identifies a log record, <code class="computeroutput">false</code>, if the <code class="computeroutput">*this</code> is not valid </p></td>
205 <li class="listitem">
206 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711350408048-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
207 <p>Inverted conversion to an unspecified boolean type</p>
210 <div class="variablelist"><table border="0" class="variablelist compact">
212 <col align="left" valign="top">
216 <td><p><span class="term">Returns:</span></p></td>
217 <td><p><code class="computeroutput">false</code>, if the <code class="computeroutput">*this</code> identifies a log record, <code class="computeroutput">true</code>, if the <code class="computeroutput">*this</code> is not valid </p></td>
221 <li class="listitem">
222 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711350403968-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="record_view.html" title="Class record_view">record_view</a> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
223 <p>Swaps two handles</p>
226 <div class="variablelist"><table border="0" class="variablelist compact">
228 <col align="left" valign="top">
232 <td><p><span class="term">Parameters:</span></p></td>
233 <td><div class="variablelist"><table border="0" class="variablelist compact">
235 <col align="left" valign="top">
239 <td><p><span class="term"><code class="computeroutput">that</code></span></p></td>
240 <td><p>Another record to swap with <span class="bold"><strong>Throws:</strong></span> Nothing </p></td>
246 <li class="listitem">
247 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711350400016-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
248 <p>Resets the log record handle. If there are no other handles left, the log record is closed and all resources referenced by the record are released.</p>
251 <div class="variablelist"><table border="0" class="variablelist compact">
253 <col align="left" valign="top">
257 <td><p><span class="term">Postconditions:</span></p></td>
258 <td><p><code class="computeroutput">!*this == true</code> </p></td>
262 <li class="listitem">
263 <pre class="literallayout"><span class="identifier">attribute_value_set</span><span class="special">::</span><span class="identifier">mapped_type</span>
264 <a name="idm45711350397200-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">attribute_value_set</span><span class="special">::</span><span class="identifier">key_type</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
265 <p>Attribute value lookup.</p>
269 <div class="variablelist"><table border="0" class="variablelist compact">
271 <col align="left" valign="top">
276 <td><p><span class="term">Parameters:</span></p></td>
277 <td><div class="variablelist"><table border="0" class="variablelist compact">
279 <col align="left" valign="top">
283 <td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
284 <td><p>Attribute name. </p></td>
289 <td><p><span class="term">Returns:</span></p></td>
290 <td><p>An <code class="computeroutput">attribute_value</code>, non-empty if it is found, empty otherwise. </p></td>
295 <li class="listitem">
296 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> DescriptorT<span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="special">></span> <span class="keyword">class</span> ActorT<span class="special">></span>
297 <span class="identifier">result_of</span><span class="special">::</span><span class="identifier">extract</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special"><</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">DescriptorT</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span>
298 <a name="idm45711350393184-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">expressions</span><span class="special">::</span><span class="identifier">attribute_keyword</span><span class="special"><</span> <span class="identifier">DescriptorT</span><span class="special">,</span> <span class="identifier">ActorT</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> keyword<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
299 <p>Attribute value lookup.</p>
303 <div class="variablelist"><table border="0" class="variablelist compact">
305 <col align="left" valign="top">
310 <td><p><span class="term">Parameters:</span></p></td>
311 <td><div class="variablelist"><table border="0" class="variablelist compact">
313 <col align="left" valign="top">
317 <td><p><span class="term"><code class="computeroutput">keyword</code></span></p></td>
318 <td><p>Attribute keyword. </p></td>
323 <td><p><span class="term">Returns:</span></p></td>
324 <td><p>A <code class="computeroutput">value_ref</code> with extracted attribute value if it is found, empty <code class="computeroutput">value_ref</code> otherwise. </p></td>
333 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
334 <td align="left"></td>
335 <td align="right"><div class="copyright-footer">Copyright © 2007-2016 Andrey Semashev<p>
336 Distributed under the Boost Software License, Version 1.0. (See accompanying
337 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>).
342 <div class="spirit-nav">
343 <a accesskey="p" href="swap_idm45711350433856.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../core_components.html#header.boost.log.core.record_view_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_idm45711350374912.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>