Grpc.Core.AsyncStreamReaderExtensions.html 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class AsyncStreamReaderExtensions
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class AsyncStreamReaderExtensions
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.36.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Core.AsyncStreamReaderExtensions">
  73. <h1 id="Grpc_Core_AsyncStreamReaderExtensions" data-uid="Grpc.Core.AsyncStreamReaderExtensions" class="text-break">Class AsyncStreamReaderExtensions
  74. </h1>
  75. <div class="markdown level0 summary"><p>Extension methods for <a class="xref" href="Grpc.Core.IAsyncStreamReader-1.html">IAsyncStreamReader&lt;T&gt;</a>.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">System.Object</span></div>
  81. <div class="level1"><span class="xref">AsyncStreamReaderExtensions</span></div>
  82. </div>
  83. <div class="inheritedMembers">
  84. <h5>Inherited Members</h5>
  85. <div>
  86. <span class="xref">System.Object.Equals(System.Object)</span>
  87. </div>
  88. <div>
  89. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  90. </div>
  91. <div>
  92. <span class="xref">System.Object.GetHashCode()</span>
  93. </div>
  94. <div>
  95. <span class="xref">System.Object.GetType()</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.MemberwiseClone()</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.ToString()</span>
  105. </div>
  106. </div>
  107. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  108. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  109. <h5 id="Grpc_Core_AsyncStreamReaderExtensions_syntax">Syntax</h5>
  110. <div class="codewrapper">
  111. <pre><code class="lang-csharp hljs">public static class AsyncStreamReaderExtensions</code></pre>
  112. </div>
  113. <h3 id="methods">Methods
  114. </h3>
  115. <a id="Grpc_Core_AsyncStreamReaderExtensions_MoveNext_" data-uid="Grpc.Core.AsyncStreamReaderExtensions.MoveNext*"></a>
  116. <h4 id="Grpc_Core_AsyncStreamReaderExtensions_MoveNext__1_Grpc_Core_IAsyncStreamReader___0__" data-uid="Grpc.Core.AsyncStreamReaderExtensions.MoveNext``1(Grpc.Core.IAsyncStreamReader{``0})">MoveNext&lt;T&gt;(IAsyncStreamReader&lt;T&gt;)</h4>
  117. <div class="markdown level1 summary"><p>Advances the stream reader to the next element in the sequence, returning the result asynchronously.</p>
  118. </div>
  119. <div class="markdown level1 conceptual"></div>
  120. <h5 class="decalaration">Declaration</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">public static Task&lt;bool&gt; MoveNext&lt;T&gt;(this IAsyncStreamReader&lt;T&gt; streamReader)
  123. where T : class</code></pre>
  124. </div>
  125. <h5 class="parameters">Parameters</h5>
  126. <table class="table table-bordered table-striped table-condensed">
  127. <thead>
  128. <tr>
  129. <th>Type</th>
  130. <th>Name</th>
  131. <th>Description</th>
  132. </tr>
  133. </thead>
  134. <tbody>
  135. <tr>
  136. <td><a class="xref" href="Grpc.Core.IAsyncStreamReader-1.html">IAsyncStreamReader</a>&lt;T&gt;</td>
  137. <td><span class="parametername">streamReader</span></td>
  138. <td><p>The stream reader.</p>
  139. </td>
  140. </tr>
  141. </tbody>
  142. </table>
  143. <h5 class="returns">Returns</h5>
  144. <table class="table table-bordered table-striped table-condensed">
  145. <thead>
  146. <tr>
  147. <th>Type</th>
  148. <th>Description</th>
  149. </tr>
  150. </thead>
  151. <tbody>
  152. <tr>
  153. <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
  154. <td><p>Task containing the result of the operation: true if the reader was successfully advanced
  155. to the next element; false if the reader has passed the end of the sequence.</p>
  156. </td>
  157. </tr>
  158. </tbody>
  159. </table>
  160. <h5 class="typeParameters">Type Parameters</h5>
  161. <table class="table table-bordered table-striped table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Name</th>
  165. <th>Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td><span class="parametername">T</span></td>
  171. <td><p>The message type.</p>
  172. </td>
  173. </tr>
  174. </tbody>
  175. </table>
  176. </article>
  177. </div>
  178. <div class="hidden-sm col-md-2" role="complementary">
  179. <div class="sideaffix">
  180. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  181. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  182. </nav>
  183. </div>
  184. </div>
  185. </div>
  186. </div>
  187. <footer>
  188. <div class="grad-bottom"></div>
  189. <div class="footer">
  190. <div class="container">
  191. <span class="pull-right">
  192. <a href="#top">Back to top</a>
  193. </span>
  194. <span>Generated by <strong>DocFX</strong></span>
  195. </div>
  196. </div>
  197. </footer>
  198. </div>
  199. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  200. <script type="text/javascript" src="../styles/docfx.js"></script>
  201. <script type="text/javascript" src="../styles/main.js"></script>
  202. </body>
  203. </html>