1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class coroutine<>::pull_type</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. Coroutine2"> 8<link rel="up" href="../asymmetric.html" title="Asymmetric coroutine"> 9<link rel="prev" href="../asymmetric.html" title="Asymmetric coroutine"> 10<link rel="next" href="push_coro.html" title="Class coroutine<>::push_type"> 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="../asymmetric.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../asymmetric.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="push_coro.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="coroutine2.coroutine.asymmetric.pull_coro"></a><a class="link" href="pull_coro.html" title="Class coroutine<>::pull_type">Class <code class="computeroutput"><span class="identifier">coroutine</span><span class="special"><>::</span><span class="identifier">pull_type</span></code></a> 28</h4></div></div></div> 29<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">coroutine2</span><span class="special">/</span><span class="identifier">coroutine</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 30 31<span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> 32<span class="keyword">class</span> <span class="identifier">coroutine</span><span class="special"><>::</span><span class="identifier">pull_type</span> 33<span class="special">{</span> 34<span class="keyword">public</span><span class="special">:</span> 35 <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Fn</span> <span class="special">></span> 36 <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">Fn</span> <span class="special">&&</span> <span class="identifier">fn</span><span class="special">);</span> 37 38 <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">StackAllocator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Fn</span> <span class="special">></span> 39 <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">StackAllocator</span> <span class="identifier">stack_alloc</span><span class="special">,</span> <span class="identifier">Fn</span> <span class="special">&&</span> <span class="identifier">fn</span><span class="special">);</span> 40 41 <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">pull_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">other</span><span class="special">)=</span><span class="keyword">delete</span><span class="special">;</span> 42 43 <span class="identifier">pull_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">pull_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">other</span><span class="special">)=</span><span class="keyword">delete</span><span class="special">;</span> 44 45 <span class="special">~</span><span class="identifier">pull_type</span><span class="special">();</span> 46 47 <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">pull_type</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 48 49 <span class="identifier">pull_type</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">pull_type</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 50 51 <span class="identifier">pull_coroutine</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">()();</span> 52 53 <span class="keyword">explicit</span> <span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">()</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 54 55 <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!()</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 56 57 <span class="identifier">R</span> <span class="identifier">get</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span> 58<span class="special">};</span> 59 60<span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> 61<span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">begin</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&);</span> 62 63<span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> 64<span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">end</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&);</span> 65</pre> 66<h6> 67<a name="coroutine2.coroutine.asymmetric.pull_coro.h0"></a> 68 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__template__phrase__phrase_role__special___lt___phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__fn__phrase___phrase_role__special___gt___phrase_____________phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__fn__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__template__phrase__phrase_role__special___lt___phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__fn__phrase___phrase_role__special___gt___phrase_____________phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__fn__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Fn</span> 69 <span class="special">></span> <span class="identifier">pull_type</span><span class="special">(</span> <span class="identifier">Fn</span> <span class="special">&&</span> <span class="identifier">fn</span><span class="special">)</span></code></a> 70 </h6> 71<div class="variablelist"> 72<p class="title"><b></b></p> 73<dl class="variablelist"> 74<dt><span class="term">Effects:</span></dt> 75<dd><p> 76 Creates a coroutine which will execute <code class="computeroutput"><span class="identifier">fn</span></code>, 77 and enters it. 78 </p></dd> 79<dt><span class="term">Throws:</span></dt> 80<dd><p> 81 Exceptions thrown inside <span class="emphasis"><em>coroutine-function</em></span>. 82 </p></dd> 83</dl> 84</div> 85<h6> 86<a name="coroutine2.coroutine.asymmetric.pull_coro.h1"></a> 87 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__template__phrase__phrase_role__special___lt___phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__stackallocator__phrase__phrase_role__special_____phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__fn__phrase___phrase_role__special___gt___phrase_____________phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__stackallocator__phrase___phrase_role__keyword__const__phrase__phrase_role__special___amp___phrase___phrase_role__identifier__stack_alloc__phrase__phrase_role__special_____phrase___phrase_role__identifier__fn__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__template__phrase__phrase_role__special___lt___phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__stackallocator__phrase__phrase_role__special_____phrase___phrase_role__keyword__typename__phrase___phrase_role__identifier__fn__phrase___phrase_role__special___gt___phrase_____________phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__stackallocator__phrase___phrase_role__keyword__const__phrase__phrase_role__special___amp___phrase___phrase_role__identifier__stack_alloc__phrase__phrase_role__special_____phrase___phrase_role__identifier__fn__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__fn__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">StackAllocator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Fn</span> <span class="special">></span> <span class="identifier">pull_type</span><span class="special">(</span> 88 <span class="identifier">StackAllocator</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">stack_alloc</span><span class="special">,</span> <span class="identifier">Fn</span> <span class="special">&&</span> <span class="identifier">fn</span><span class="special">)</span></code></a> 89 </h6> 90<div class="variablelist"> 91<p class="title"><b></b></p> 92<dl class="variablelist"> 93<dt><span class="term">Effects:</span></dt> 94<dd><p> 95 Creates a coroutine which will execute <code class="computeroutput"><span class="identifier">fn</span></code>. 96 For allocating/deallocating the stack <code class="computeroutput"><span class="identifier">stack_alloc</span></code> 97 is used. 98 </p></dd> 99<dt><span class="term">Throws:</span></dt> 100<dd><p> 101 Exceptions thrown inside <span class="emphasis"><em>coroutine-function</em></span>. 102 </p></dd> 103</dl> 104</div> 105<h6> 106<a name="coroutine2.coroutine.asymmetric.pull_coro.h2"></a> 107 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__special_____phrase__phrase_role__identifier__pull_type__phrase__phrase_role__special______phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__special_____phrase__phrase_role__identifier__pull_type__phrase__phrase_role__special______phrase___code_"><code class="computeroutput"><span class="special">~</span><span class="identifier">pull_type</span><span class="special">()</span></code></a> 108 </h6> 109<div class="variablelist"> 110<p class="title"><b></b></p> 111<dl class="variablelist"> 112<dt><span class="term">Effects:</span></dt> 113<dd><p> 114 Destroys the context and deallocates the stack. 115 </p></dd> 116</dl> 117</div> 118<h6> 119<a name="coroutine2.coroutine.asymmetric.pull_coro.h3"></a> 120 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="identifier">pull_type</span><span class="special">(</span> 121 <span class="identifier">pull_type</span> <span class="special">&&</span> 122 <span class="identifier">other</span><span class="special">)</span></code></a> 123 </h6> 124<div class="variablelist"> 125<p class="title"><b></b></p> 126<dl class="variablelist"> 127<dt><span class="term">Effects:</span></dt> 128<dd><p> 129 Moves the internal data of <code class="computeroutput"><span class="identifier">other</span></code> 130 to <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>. 131 <code class="computeroutput"><span class="identifier">other</span></code> becomes <span class="emphasis"><em>not-a-coroutine</em></span>. 132 </p></dd> 133<dt><span class="term">Throws:</span></dt> 134<dd><p> 135 Nothing. 136 </p></dd> 137</dl> 138</div> 139<h6> 140<a name="coroutine2.coroutine.asymmetric.pull_coro.h4"></a> 141 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special______phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special______phrase___phrase_role__identifier__pull_type__phrase___phrase_role__special___amp__amp___phrase___phrase_role__identifier__other__phrase__phrase_role__special_____phrase___code_"><code class="computeroutput"><span class="identifier">pull_type</span> <span class="special">&</span> 142 <span class="keyword">operator</span><span class="special">=(</span> 143 <span class="identifier">pull_type</span> <span class="special">&&</span> 144 <span class="identifier">other</span><span class="special">)</span></code></a> 145 </h6> 146<div class="variablelist"> 147<p class="title"><b></b></p> 148<dl class="variablelist"> 149<dt><span class="term">Effects:</span></dt> 150<dd><p> 151 Destroys the internal data of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> and moves the internal data of 152 <code class="computeroutput"><span class="identifier">other</span></code> to <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>. 153 <code class="computeroutput"><span class="identifier">other</span></code> becomes <span class="emphasis"><em>not-a-coroutine</em></span>. 154 </p></dd> 155<dt><span class="term">Throws:</span></dt> 156<dd><p> 157 Nothing. 158 </p></dd> 159</dl> 160</div> 161<h6> 162<a name="coroutine2.coroutine.asymmetric.pull_coro.h5"></a> 163 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__explicit__phrase___phrase_role__keyword__operator__phrase___phrase_role__keyword__bool__phrase__phrase_role__special______phrase___phrase_role__keyword__const__phrase___phrase_role__keyword__noexcept__phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__explicit__phrase___phrase_role__keyword__operator__phrase___phrase_role__keyword__bool__phrase__phrase_role__special______phrase___phrase_role__keyword__const__phrase___phrase_role__keyword__noexcept__phrase___code_"><code class="computeroutput"><span class="keyword">explicit</span> <span class="keyword">operator</span> 164 <span class="keyword">bool</span><span class="special">()</span> 165 <span class="keyword">const</span> <span class="keyword">noexcept</span></code></a> 166 </h6> 167<div class="variablelist"> 168<p class="title"><b></b></p> 169<dl class="variablelist"> 170<dt><span class="term">Returns:</span></dt> 171<dd><p> 172 If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 173 refers to <span class="emphasis"><em>not-a-coroutine</em></span> or the coroutine-function 174 has returned (completed), the function returns <code class="computeroutput"><span class="keyword">false</span></code>. 175 Otherwise <code class="computeroutput"><span class="keyword">true</span></code>. 176 </p></dd> 177<dt><span class="term">Throws:</span></dt> 178<dd><p> 179 Nothing. 180 </p></dd> 181</dl> 182</div> 183<h6> 184<a name="coroutine2.coroutine.asymmetric.pull_coro.h6"></a> 185 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__bool__phrase___phrase_role__keyword__operator__phrase__phrase_role__special_______phrase___phrase_role__keyword__const__phrase___phrase_role__keyword__noexcept__phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__keyword__bool__phrase___phrase_role__keyword__operator__phrase__phrase_role__special_______phrase___phrase_role__keyword__const__phrase___phrase_role__keyword__noexcept__phrase___code_"><code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!()</span> <span class="keyword">const</span> <span class="keyword">noexcept</span></code></a> 186 </h6> 187<div class="variablelist"> 188<p class="title"><b></b></p> 189<dl class="variablelist"> 190<dt><span class="term">Returns:</span></dt> 191<dd><p> 192 If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 193 refers to <span class="emphasis"><em>not-a-coroutine</em></span> or the coroutine-function 194 has returned (completed), the function returns <code class="computeroutput"><span class="keyword">true</span></code>. 195 Otherwise <code class="computeroutput"><span class="keyword">false</span></code>. 196 </p></dd> 197<dt><span class="term">Throws:</span></dt> 198<dd><p> 199 Nothing. 200 </p></dd> 201</dl> 202</div> 203<h6> 204<a name="coroutine2.coroutine.asymmetric.pull_coro.h7"></a> 205 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special___lt__gt___phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special________phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__pull_type__phrase__phrase_role__special___lt__gt___phrase___phrase_role__special___amp___phrase___phrase_role__keyword__operator__phrase__phrase_role__special________phrase___code_"><code class="computeroutput"><span class="identifier">pull_type</span><span class="special"><></span> 206 <span class="special">&</span> <span class="keyword">operator</span><span class="special">()()</span></code></a> 207 </h6> 208<div class="variablelist"> 209<p class="title"><b></b></p> 210<dl class="variablelist"> 211<dt><span class="term">Preconditions:</span></dt> 212<dd><p> 213 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 214 is not a <span class="emphasis"><em>not-a-coroutine</em></span>. 215 </p></dd> 216<dt><span class="term">Effects:</span></dt> 217<dd><p> 218 Execution control is transferred to <span class="emphasis"><em>coroutine-function</em></span> 219 (no parameter is passed to the coroutine-function). 220 </p></dd> 221<dt><span class="term">Throws:</span></dt> 222<dd><p> 223 Exceptions thrown inside <span class="emphasis"><em>coroutine-function</em></span>. 224 </p></dd> 225</dl> 226</div> 227<h6> 228<a name="coroutine2.coroutine.asymmetric.pull_coro.h8"></a> 229 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__r__phrase___phrase_role__identifier__get__phrase__phrase_role__special______phrase___phrase_role__keyword__noexcept__phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro._code__phrase_role__identifier__r__phrase___phrase_role__identifier__get__phrase__phrase_role__special______phrase___phrase_role__keyword__noexcept__phrase___code_"><code class="computeroutput"><span class="identifier">R</span> <span class="identifier">get</span><span class="special">()</span> <span class="keyword">noexcept</span></code></a> 230 </h6> 231<pre class="programlisting"><span class="identifier">R</span> <span class="identifier">coroutine</span><span class="special"><</span><span class="identifier">R</span><span class="special">,</span><span class="identifier">StackAllocator</span><span class="special">>::</span><span class="identifier">pull_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">();</span> 232<span class="identifier">R</span><span class="special">&</span> <span class="identifier">coroutine</span><span class="special"><</span><span class="identifier">R</span><span class="special">&,</span><span class="identifier">StackAllocator</span><span class="special">>::</span><span class="identifier">pull_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">();</span> 233<span class="keyword">void</span> <span class="identifier">coroutine</span><span class="special"><</span><span class="keyword">void</span><span class="special">,</span><span class="identifier">StackAllocator</span><span class="special">>::</span><span class="identifier">pull_type</span><span class="special">::</span><span class="identifier">get</span><span class="special">()=</span><span class="keyword">delete</span><span class="special">;</span> 234</pre> 235<div class="variablelist"> 236<p class="title"><b></b></p> 237<dl class="variablelist"> 238<dt><span class="term">Preconditions:</span></dt> 239<dd><p> 240 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 241 is not a <span class="emphasis"><em>not-a-coroutine</em></span>. 242 </p></dd> 243<dt><span class="term">Returns:</span></dt> 244<dd><p> 245 Returns data transferred from coroutine-function via <span class="emphasis"><em>coroutine<>::push_type::operator()</em></span>. 246 </p></dd> 247<dt><span class="term">Throws:</span></dt> 248<dd><p> 249 <code class="computeroutput"><span class="identifier">invalid_result</span></code> 250 </p></dd> 251<dt><span class="term">Note:</span></dt> 252<dd><p> 253 If <code class="computeroutput"><span class="identifier">R</span></code> is a move-only 254 type, you may only call <code class="computeroutput"><span class="identifier">get</span><span class="special">()</span></code> once before the next <span class="emphasis"><em>coroutine<>::pull_type::operator()</em></span> 255 call. 256 </p></dd> 257</dl> 258</div> 259<h6> 260<a name="coroutine2.coroutine.asymmetric.pull_coro.h9"></a> 261 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__begin__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase__phrase_role__special___lt___phrase___phrase_role__identifier__r__phrase___phrase_role__special___gt___phrase___phrase_role__special___amp____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__begin__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase__phrase_role__special___lt___phrase___phrase_role__identifier__r__phrase___phrase_role__special___gt___phrase___phrase_role__special___amp____phrase___code_">Non-member 262 function <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span> 263 <span class="identifier">pull_type</span><span class="special"><</span> 264 <span class="identifier">R</span> <span class="special">></span> 265 <span class="special">&)</span></code></a> 266 </h6> 267<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> 268<span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">begin</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&);</span> 269</pre> 270<div class="variablelist"> 271<p class="title"><b></b></p> 272<dl class="variablelist"> 273<dt><span class="term">Returns:</span></dt> 274<dd><p> 275 Returns a range-iterator (input-iterator). 276 </p></dd> 277</dl> 278</div> 279<h6> 280<a name="coroutine2.coroutine.asymmetric.pull_coro.h10"></a> 281 <span class="phrase"><a name="coroutine2.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__end__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase__phrase_role__special___lt___phrase___phrase_role__identifier__r__phrase___phrase_role__special___gt___phrase___phrase_role__special___amp____phrase___code_"></a></span><a class="link" href="pull_coro.html#coroutine2.coroutine.asymmetric.pull_coro.non_member_function__code__phrase_role__identifier__end__phrase__phrase_role__special_____phrase___phrase_role__identifier__pull_type__phrase__phrase_role__special___lt___phrase___phrase_role__identifier__r__phrase___phrase_role__special___gt___phrase___phrase_role__special___amp____phrase___code_">Non-member 282 function <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span> 283 <span class="identifier">pull_type</span><span class="special"><</span> 284 <span class="identifier">R</span> <span class="special">></span> 285 <span class="special">&)</span></code></a> 286 </h6> 287<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">R</span> <span class="special">></span> 288<span class="identifier">range_iterator</span><span class="special"><</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">end</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> <span class="special">></span> <span class="special">&);</span> 289</pre> 290<div class="variablelist"> 291<p class="title"><b></b></p> 292<dl class="variablelist"> 293<dt><span class="term">Returns:</span></dt> 294<dd><p> 295 Returns an end range-iterator (input-iterator). 296 </p></dd> 297<dt><span class="term">Note:</span></dt> 298<dd><p> 299 When first obtained from <code class="computeroutput"><span class="identifier">begin</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> 300 <span class="special">></span> <span class="special">&)</span></code>, 301 or after some number of increment operations, an iterator will compare 302 equal to the iterator returned by <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span> <span class="identifier">pull_type</span><span class="special"><</span> <span class="identifier">R</span> 303 <span class="special">></span> <span class="special">&)</span></code> 304 when the corresponding <span class="emphasis"><em>coroutine<>::pull_type::operator 305 bool</em></span> would return <code class="computeroutput"><span class="keyword">false</span></code>. 306 </p></dd> 307</dl> 308</div> 309</div> 310<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 311<td align="left"></td> 312<td align="right"><div class="copyright-footer">Copyright © 2014 Oliver Kowalke<p> 313 Distributed under the Boost Software License, Version 1.0. (See accompanying 314 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>) 315 </p> 316</div></td> 317</tr></table> 318<hr> 319<div class="spirit-nav"> 320<a accesskey="p" href="../asymmetric.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../asymmetric.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="push_coro.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 321</div> 322</body> 323</html> 324
