libs/beast/doc/html/beast/ref/boost__beast__http__is_body_reader.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::is_body_reader</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.Beast">
   8 <link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__http__is_body.html" title="http::is_body">
  10 <link rel="next" href="boost__beast__http__is_body_writer.html" title="http::is_body_writer">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="boost__beast__http__is_body.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><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="boost__beast__http__is_body_writer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="beast.ref.boost__beast__http__is_body_reader"></a><a class="link" href="boost__beast__http__is_body_reader.html" title="http::is_body_reader">http::is_body_reader</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873496912768"></a>
  31 Determine if a type has a nested <span class="emphasis"><em>BodyReader</em></span>.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__http__is_body_reader.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__http__is_body_reader.synopsis"></a></span><a class="link" href="boost__beast__http__is_body_reader.html#beast.ref.boost__beast__http__is_body_reader.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/http/type_traits.hpp" target="_top">boost/beast/http/type_traits.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  41     <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  42 <span class="keyword">using</span> <span class="identifier">is_body_reader</span> <span class="special">=</span> <span class="emphasis"><em>see-below</em></span><span class="special">;</span>
  43 </pre>
  44 <h5>
  45 <a name="beast.ref.boost__beast__http__is_body_reader.h1"></a>
  46         <span class="phrase"><a name="beast.ref.boost__beast__http__is_body_reader.description"></a></span><a class="link" href="boost__beast__http__is_body_reader.html#beast.ref.boost__beast__http__is_body_reader.description">Description</a>
  47       </h5>
  48 <p>
  49         This alias template is <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">true_type</span></code>
  50         when:
  51       </p>
  52 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  53 <li class="listitem">
  54             <code class="computeroutput"><span class="identifier">T</span></code> has a nested type named
  55             <code class="computeroutput"><span class="identifier">reader</span></code>
  56           </li>
  57 <li class="listitem">
  58             <code class="computeroutput"><span class="identifier">reader</span></code> meets the requirements
  59             of <span class="emphasis"><em>BodyReader</em></span>.
  60           </li>
  61 </ul></div>
  62 <h5>
  63 <a name="beast.ref.boost__beast__http__is_body_reader.h2"></a>
  64         <span class="phrase"><a name="beast.ref.boost__beast__http__is_body_reader.template_parameters"></a></span><a class="link" href="boost__beast__http__is_body_reader.html#beast.ref.boost__beast__http__is_body_reader.template_parameters">Template
  65         Parameters</a>
  66       </h5>
  67 <div class="informaltable"><table class="table">
  68 <colgroup>
  69 <col>
  70 <col>
  71 </colgroup>
  72 <thead><tr>
  73 <th>
  74                 <p>
  75                   Type
  76                 </p>
  77               </th>
  78 <th>
  79                 <p>
  80                   Description
  81                 </p>
  82               </th>
  83 </tr></thead>
  84 <tbody><tr>
  85 <td>
  86                 <p>
  87                   <code class="computeroutput"><span class="identifier">T</span></code>
  88                 </p>
  89               </td>
  90 <td>
  91                 <p>
  92                   The body type to test.
  93                 </p>
  94               </td>
  95 </tr></tbody>
  96 </table></div>
  97 <h5>
  98 <a name="beast.ref.boost__beast__http__is_body_reader.h3"></a>
  99         <span class="phrase"><a name="beast.ref.boost__beast__http__is_body_reader.example"></a></span><a class="link" href="boost__beast__http__is_body_reader.html#beast.ref.boost__beast__http__is_body_reader.example">Example</a>
 100       </h5>
 101 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Body</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Fields</span><span class="special">&gt;</span>
 102 <span class="keyword">void</span> <span class="identifier">check_can_parse</span><span class="special">(</span><span class="identifier">message</span><span class="special">&lt;</span><span class="identifier">isRequest</span><span class="special">,</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">Fields</span><span class="special">&gt;&amp;)</span>
 103 <span class="special">{</span>
 104     <span class="keyword">static_assert</span><span class="special">(</span><span class="identifier">is_body_reader</span><span class="special">&lt;</span><span class="identifier">Body</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">,</span>
 105         <span class="string">"Cannot parse Body, no reader"</span><span class="special">);</span>
 106 <span class="special">}</span>
 107 </pre>
 108 <p>
 109         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/http.hpp" target="_top">boost/beast/http.hpp</a>&gt;</code>
 110       </p>
 111 </div>
 112 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 113 <td align="left"></td>
 114 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 115       Falco<p>
 116         Distributed under the Boost Software License, Version 1.0. (See accompanying
 117         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>)
 118       </p>
 119 </div></td>
 120 </tr></table>
 121 <hr>
 122 <div class="spirit-nav">
 123 <a accesskey="p" href="boost__beast__http__is_body.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><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="boost__beast__http__is_body_writer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 124 </div>
 125 </body>
 126 </html>