libs/beast/doc/html/beast/ref/boost__beast__http__is_body.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::is_body</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__int_to_status.html" title="http::int_to_status">
  10 <link rel="next" href="boost__beast__http__is_body_reader.html" title="http::is_body_reader">
  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__int_to_status.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_reader.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"></a><a class="link" href="boost__beast__http__is_body.html" title="http::is_body">http::is_body</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873496974384"></a>
  31 Determine if a type meets the <span class="emphasis"><em>Body</em></span> named
  32         requirements.
  33       </p>
  34 <h5>
  35 <a name="beast.ref.boost__beast__http__is_body.h0"></a>
  36         <span class="phrase"><a name="beast.ref.boost__beast__http__is_body.synopsis"></a></span><a class="link" href="boost__beast__http__is_body.html#beast.ref.boost__beast__http__is_body.synopsis">Synopsis</a>
  37       </h5>
  38 <p>
  39         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>
  40       </p>
  41 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  42     <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  43 <span class="keyword">using</span> <span class="identifier">is_body</span> <span class="special">=</span> <span class="emphasis"><em>see-below</em></span><span class="special">;</span>
  44 </pre>
  45 <h5>
  46 <a name="beast.ref.boost__beast__http__is_body.h1"></a>
  47         <span class="phrase"><a name="beast.ref.boost__beast__http__is_body.description"></a></span><a class="link" href="boost__beast__http__is_body.html#beast.ref.boost__beast__http__is_body.description">Description</a>
  48       </h5>
  49 <p>
  50         This alias template is <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">true_type</span></code>
  51         if <code class="computeroutput"><span class="identifier">T</span></code> meets the requirements,
  52         otherwise it is <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">false_type</span></code>.
  53       </p>
  54 <h5>
  55 <a name="beast.ref.boost__beast__http__is_body.h2"></a>
  56         <span class="phrase"><a name="beast.ref.boost__beast__http__is_body.template_parameters"></a></span><a class="link" href="boost__beast__http__is_body.html#beast.ref.boost__beast__http__is_body.template_parameters">Template
  57         Parameters</a>
  58       </h5>
  59 <div class="informaltable"><table class="table">
  60 <colgroup>
  61 <col>
  62 <col>
  63 </colgroup>
  64 <thead><tr>
  65 <th>
  66                 <p>
  67                   Type
  68                 </p>
  69               </th>
  70 <th>
  71                 <p>
  72                   Description
  73                 </p>
  74               </th>
  75 </tr></thead>
  76 <tbody><tr>
  77 <td>
  78                 <p>
  79                   <code class="computeroutput"><span class="identifier">T</span></code>
  80                 </p>
  81               </td>
  82 <td>
  83                 <p>
  84                   The type to test.
  85                 </p>
  86               </td>
  87 </tr></tbody>
  88 </table></div>
  89 <h5>
  90 <a name="beast.ref.boost__beast__http__is_body.h3"></a>
  91         <span class="phrase"><a name="beast.ref.boost__beast__http__is_body.example"></a></span><a class="link" href="boost__beast__http__is_body.html#beast.ref.boost__beast__http__is_body.example">Example</a>
  92       </h5>
  93 <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>
  94 <span class="keyword">void</span> <span class="identifier">check_body</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;</span> <span class="keyword">const</span><span class="special">&amp;)</span>
  95 <span class="special">{</span>
  96     <span class="keyword">static_assert</span><span class="special">(</span><span class="identifier">is_body</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>
  97         <span class="string">"Body type requirements not met"</span><span class="special">);</span>
  98 <span class="special">}</span>
  99 </pre>
 100 <p>
 101         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/http.hpp" target="_top">boost/beast/http.hpp</a>&gt;</code>
 102       </p>
 103 </div>
 104 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 105 <td align="left"></td>
 106 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 107       Falco<p>
 108         Distributed under the Boost Software License, Version 1.0. (See accompanying
 109         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>)
 110       </p>
 111 </div></td>
 112 </tr></table>
 113 <hr>
 114 <div class="spirit-nav">
 115 <a accesskey="p" href="boost__beast__http__int_to_status.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_reader.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 116 </div>
 117 </body>
 118 </html>