libs/log/doc/html/boost/log/expressions/max_size_decor_idp62967536.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template max_size_decorator_terminal</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.formatters.max_size_decorator_hpp" title="Header &lt;boost/log/expressions/formatters/max_size_decorator.hpp&gt;">
   9 <link rel="prev" href="if_.html" title="Function template if_">
  10 <link rel="next" href="max_size_decorator_actor.html" title="Class template max_size_decorator_actor">
  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="if_.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.max_size_decorator_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="max_size_decorator_actor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.max_size_decor_idp62967536"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template max_size_decorator_terminal</span></h2>
  22 <p>boost::log::expressions::max_size_decorator_terminal</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.formatters.max_size_decorator_hpp" title="Header &lt;boost/log/expressions/formatters/max_size_decorator.hpp&gt;">boost/log/expressions/formatters/max_size_decorator.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SubactorT<span class="special">,</span> <span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="max_size_decor_idp62967536.html" title="Class template max_size_decorator_terminal">max_size_decorator_terminal</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="identifier">CharT</span>                                 <a name="boost.log.expressions.max_size_decor_idp62967536.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>      <span class="comment">// Character type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span>        <a name="boost.log.expressions.max_size_decor_idp62967536.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>    <span class="comment">// String type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>                           <a name="boost.log.expressions.max_size_decor_idp62967536.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>      <span class="comment">// String size type. </span>
  34   <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.expressions.max_size_decor_idp62967536.stream_type"></a><span class="identifier">stream_type</span><span class="special">;</span>    <span class="comment">// Stream type. </span>
  35   <span class="keyword">typedef</span> <span class="identifier">SubactorT</span>                             <a name="boost.log.expressions.max_size_decor_idp62967536.subactor_type"></a><span class="identifier">subactor_type</span><span class="special">;</span>  <span class="comment">// Adopted actor type. </span>
  36   <span class="keyword">typedef</span> <span class="identifier">string_type</span>                           <a name="boost.log.expressions.max_size_decor_idp62967536.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>    <span class="comment">// Result type definition. </span>
  37
  38   <span class="comment">// <a class="link" href="max_size_decor_idp62967536.html#boost.log.expressions.max_size_decor_idp62967536construct-copy-destruct">construct/copy/destruct</a></span>
  39   <a class="link" href="max_size_decor_idp62967536.html#idp62991664-bb"><span class="identifier">max_size_decorator_terminal</span></a><span class="special">(</span><span class="identifier">subactor_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span>
  40                               <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">string_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="max_size_decor_idp62967536.html#idp62994736-bb"><span class="identifier">max_size_decorator_terminal</span></a><span class="special">(</span><a class="link" href="max_size_decor_idp62967536.html" title="Class template max_size_decorator_terminal">max_size_decorator_terminal</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42   <a class="link" href="max_size_decor_idp62967536.html#idp62996432-bb"><span class="identifier">max_size_decorator_terminal</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="max_size_decor_idp62967536.html#idp62979216-bb">public member functions</a></span>
  45   <span class="identifier">subactor_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="max_size_decor_idp62967536.html#idp62979776-bb"><span class="identifier">get_subactor</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  46   <span class="identifier">size_type</span> <a class="link" href="max_size_decor_idp62967536.html#idp62981728-bb"><span class="identifier">get_max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="max_size_decor_idp62967536.html#idp62983680-bb"><span class="identifier">get_overflow_marker</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="max_size_decor_idp62967536.html#idp62985632-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  49   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="max_size_decor_idp62967536.html#idp62988432-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50 <span class="special">}</span><span class="special">;</span></pre></div>
  51 <div class="refsect1">
  52 <a name="idp113784768"></a><h2>Description</h2>
  53 <p>String size limiting decorator terminal class. This formatter allows to limit the maximum total length of the strings generated by other formatters.</p>
  54 <p>The <code class="computeroutput"><a class="link" href="max_size_decor_idp62967536.html" title="Class template max_size_decorator_terminal">max_size_decorator_terminal</a></code> class aggregates the formatter being decorated, the maximum string length it can produce and an optional truncation marker string, which will be put at the end of the output if the limit is exceeded. Note that the marker length is included in the limit and as such must not exceed it. The <code class="computeroutput"><a class="link" href="max_size_decor_idp62967536.html" title="Class template max_size_decorator_terminal">max_size_decorator_terminal</a></code> class is a formatter itself, so it can be used to construct more complex formatters, including nesting decorators. </p>
  55 <div class="refsect2">
  56 <a name="idp113788944"></a><h3>
  57 <a name="boost.log.expressions.max_size_decor_idp62967536construct-copy-destruct"></a><code class="computeroutput">max_size_decorator_terminal</code>
  58         public
  59        construct/copy/destruct</h3>
  60 <div class="orderedlist"><ol class="orderedlist" type="1">
  61 <li class="listitem">
  62 <pre class="literallayout"><a name="idp62991664-bb"></a><span class="identifier">max_size_decorator_terminal</span><span class="special">(</span><span class="identifier">subactor_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> sub<span class="special">,</span> <span class="identifier">size_type</span> max_size<span class="special">,</span>
  63                             <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> overflow_marker <span class="special">=</span> <span class="identifier">string_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
  64 <p>Initializing constructor. </p>
  65 </li>
  66 <li class="listitem">
  67 <pre class="literallayout"><a name="idp62994736-bb"></a><span class="identifier">max_size_decorator_terminal</span><span class="special">(</span><a class="link" href="max_size_decor_idp62967536.html" title="Class template max_size_decorator_terminal">max_size_decorator_terminal</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  68 <p>Copy constructor </p>
  69 </li>
  70 <li class="listitem"><pre class="literallayout"><a name="idp62996432-bb"></a><span class="identifier">max_size_decorator_terminal</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  71 </ol></div>
  72 </div>
  73 <div class="refsect2">
  74 <a name="idp113814768"></a><h3>
  75 <a name="idp62979216-bb"></a><code class="computeroutput">max_size_decorator_terminal</code> public member functions</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1">
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="identifier">subactor_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp62979776-bb"></a><span class="identifier">get_subactor</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  79 <p>
  80 </p>
  81 <div class="variablelist"><table border="0" class="variablelist compact">
  82 <colgroup>
  83 <col align="left" valign="top">
  84 <col>
  85 </colgroup>
  86 <tbody><tr>
  87 <td><p><span class="term">Returns:</span></p></td>
  88 <td><p>Adopted subactor </p></td>
  89 </tr></tbody>
  90 </table></div>
  91 </li>
  92 <li class="listitem">
  93 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62981728-bb"></a><span class="identifier">get_max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  94 <p>
  95 </p>
  96 <div class="variablelist"><table border="0" class="variablelist compact">
  97 <colgroup>
  98 <col align="left" valign="top">
  99 <col>
 100 </colgroup>
 101 <tbody><tr>
 102 <td><p><span class="term">Returns:</span></p></td>
 103 <td><p>Max string size limit </p></td>
 104 </tr></tbody>
 105 </table></div>
 106 </li>
 107 <li class="listitem">
 108 <pre class="literallayout"><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp62983680-bb"></a><span class="identifier">get_overflow_marker</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 109 <p>
 110 </p>
 111 <div class="variablelist"><table border="0" class="variablelist compact">
 112 <colgroup>
 113 <col align="left" valign="top">
 114 <col>
 115 </colgroup>
 116 <tbody><tr>
 117 <td><p><span class="term">Returns:</span></p></td>
 118 <td><p>Max string size limit </p></td>
 119 </tr></tbody>
 120 </table></div>
 121 </li>
 122 <li class="listitem">
 123 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idp62985632-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span> ctx<span class="special">)</span><span class="special">;</span></pre>
 124 <p>Invokation operator </p>
 125 </li>
 126 <li class="listitem">
 127 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idp62988432-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span> ctx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 128 <p>Invokation operator </p>
 129 </li>
 130 </ol></div>
 131 </div>
 132 </div>
 133 </div>
 134 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 135 <td align="left"></td>
 136 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 137         Distributed under the Boost Software License, Version 1.0. (See accompanying
 138         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>).
 139       </p>
 140 </div></td>
 141 </tr></table>
 142 <hr>
 143 <div class="spirit-nav">
 144 <a accesskey="p" href="if_.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.max_size_decorator_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="max_size_decorator_actor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 145 </div>
 146 </body>
 147 </html>