libs/beast/doc/html/beast/ref/boost__beast__is_sync_read_stream.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>is_sync_read_stream</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__is_mutable_buffer_sequence.html" title="is_mutable_buffer_sequence">
  10 <link rel="next" href="boost__beast__is_sync_stream.html" title="is_sync_stream">
  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__is_mutable_buffer_sequence.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__is_sync_stream.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__is_sync_read_stream"></a><a class="link" href="boost__beast__is_sync_read_stream.html" title="is_sync_read_stream">is_sync_read_stream</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873487559456"></a>
  31 Determine if at type meets the requirements of <span class="emphasis"><em>SyncReadStream</em></span>.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__is_sync_read_stream.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__is_sync_read_stream.synopsis"></a></span><a class="link" href="boost__beast__is_sync_read_stream.html#beast.ref.boost__beast__is_sync_read_stream.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/stream_traits.hpp" target="_top">boost/beast/core/stream_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_sync_read_stream</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__is_sync_read_stream.h1"></a>
  46         <span class="phrase"><a name="beast.ref.boost__beast__is_sync_read_stream.description"></a></span><a class="link" href="boost__beast__is_sync_read_stream.html#beast.ref.boost__beast__is_sync_read_stream.description">Description</a>
  47       </h5>
  48 <p>
  49         Metafunctions are used to perform compile time checking of template types.
  50         This type will be <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">true_type</span></code> if <code class="computeroutput"><span class="identifier">T</span></code>
  51         meets the requirements, else the type will be <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">false_type</span></code>.
  52       </p>
  53 <h5>
  54 <a name="beast.ref.boost__beast__is_sync_read_stream.h2"></a>
  55         <span class="phrase"><a name="beast.ref.boost__beast__is_sync_read_stream.example"></a></span><a class="link" href="boost__beast__is_sync_read_stream.html#beast.ref.boost__beast__is_sync_read_stream.example">Example</a>
  56       </h5>
  57 <p>
  58         Use with <code class="computeroutput"><span class="keyword">static_assert</span></code>:
  59       </p>
  60 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">SyncReadStream</span><span class="special">&gt;</span>
  61 <span class="keyword">void</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">SyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">)</span>
  62 <span class="special">{</span>
  63     <span class="keyword">static_assert</span><span class="special">(</span><span class="identifier">is_sync_read_stream</span><span class="special">&lt;</span><span class="identifier">SyncReadStream</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">,</span>
  64         <span class="string">"SyncReadStream type requirements not met"</span><span class="special">);</span>
  65 <span class="special">...</span>
  66 </pre>
  67 <p>
  68         Use with <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if</span></code> (SFINAE):
  69       </p>
  70 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">SyncReadStream</span><span class="special">&gt;</span>
  71 <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span><span class="identifier">is_sync_read_stream</span><span class="special">&lt;</span><span class="identifier">SyncReadStream</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">&gt;::</span><span class="identifier">type</span>
  72 <span class="identifier">f</span><span class="special">(</span><span class="identifier">SyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">);</span>
  73 </pre>
  74 <p>
  75         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
  76       </p>
  77 </div>
  78 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  79 <td align="left"></td>
  80 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  81       Falco<p>
  82         Distributed under the Boost Software License, Version 1.0. (See accompanying
  83         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>)
  84       </p>
  85 </div></td>
  86 </tr></table>
  87 <hr>
  88 <div class="spirit-nav">
  89 <a accesskey="p" href="boost__beast__is_mutable_buffer_sequence.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__is_sync_stream.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  90 </div>
  91 </body>
  92 </html>