• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>is_async_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 1. 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_sync_stream.html" title="is_sync_stream">
10<link rel="next" href="boost__beast__is_async_write_stream.html" title="is_async_write_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_sync_stream.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_async_write_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_async_read_stream"></a><a class="link" href="boost__beast__is_async_read_stream.html" title="is_async_read_stream">is_async_read_stream</a>
28</h4></div></div></div>
29<p>
30        <a class="indexterm" name="idm46057514098832"></a>
31      </p>
32<p>
33        Determine if <code class="computeroutput"><span class="identifier">T</span></code> meets the
34        requirements of <span class="emphasis"><em>AsyncReadStream</em></span>.
35      </p>
36<h5>
37<a name="beast.ref.boost__beast__is_async_read_stream.h0"></a>
38        <span class="phrase"><a name="beast.ref.boost__beast__is_async_read_stream.synopsis"></a></span><a class="link" href="boost__beast__is_async_read_stream.html#beast.ref.boost__beast__is_async_read_stream.synopsis">Synopsis</a>
39      </h5>
40<p>
41        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>
42      </p>
43<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
44    <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
45<span class="keyword">using</span> <span class="identifier">is_async_read_stream</span> <span class="special">=</span> <span class="emphasis"><em>see-below</em></span><span class="special">;</span>
46</pre>
47<h5>
48<a name="beast.ref.boost__beast__is_async_read_stream.h1"></a>
49        <span class="phrase"><a name="beast.ref.boost__beast__is_async_read_stream.description"></a></span><a class="link" href="boost__beast__is_async_read_stream.html#beast.ref.boost__beast__is_async_read_stream.description">Description</a>
50      </h5>
51<p>
52        Metafunctions are used to perform compile time checking of template types.
53        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>
54        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>.
55      </p>
56<h5>
57<a name="beast.ref.boost__beast__is_async_read_stream.h2"></a>
58        <span class="phrase"><a name="beast.ref.boost__beast__is_async_read_stream.example"></a></span><a class="link" href="boost__beast__is_async_read_stream.html#beast.ref.boost__beast__is_async_read_stream.example">Example</a>
59      </h5>
60<p>
61        Use with <code class="computeroutput"><span class="keyword">static_assert</span></code>:
62      </p>
63<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">AsyncReadStream</span><span class="special">&gt;</span>
64<span class="keyword">void</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">AsyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">)</span>
65<span class="special">{</span>
66    <span class="keyword">static_assert</span><span class="special">(</span><span class="identifier">is_async_read_stream</span><span class="special">&lt;</span><span class="identifier">AsyncReadStream</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">,</span>
67        <span class="string">"AsyncReadStream type requirements not met"</span><span class="special">);</span>
68<span class="special">...</span>
69</pre>
70<p>
71        Use with <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if</span></code> (SFINAE):
72      </p>
73<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">AsyncReadStream</span><span class="special">&gt;</span>
74<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_async_read_stream</span><span class="special">&lt;</span><span class="identifier">AsyncReadStream</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">&gt;::</span><span class="identifier">type</span>
75<span class="identifier">f</span><span class="special">(</span><span class="identifier">AsyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">);</span>
76</pre>
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 © 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_sync_stream.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_async_write_stream.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
90</div>
91</body>
92</html>
93