UniTask/api/Cysharp.Threading.Tasks.Cha...

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>ChannelReader&lt;T&gt; Class
   | UniTask </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="ChannelReader&lt;T&gt; Class
   | UniTask ">
    <meta name="generator" content="docfx 2.51.0.0">
    
    <link rel="shortcut icon" href="../img/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link rel="stylesheet" href="../styles/cysharp.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-default ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <div class="navbar-brand">
                <a href="../">
                  <img id="logo" src="../img/Icon.png" alt="">
                  <span>UniTask</span>
                </a>
              </div>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="Cysharp.Threading.Tasks.ChannelReader`1">
  
  <h1 id="Cysharp_Threading_Tasks_ChannelReader_1" data-uid="Cysharp.Threading.Tasks.ChannelReader`1" class="text-break">ChannelReader&lt;T&gt; Class
  </h1>
  <h6><strong>Namespace</strong>: <a class="xref" href="Cysharp.Threading.Tasks.html">Cysharp.Threading.Tasks</a></h6>
  <h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
  
  <div class="markdown level0 summary"></div>
  <div class="markdown level0 conceptual"></div>
  
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract class ChannelReader&lt;T&gt;</code></pre>
  </div>

  <div class="inheritance">
    <h5>Inheritance</h5>
    <span><span class="xref">System.Object</span></span> → 
    <span class="xref">ChannelReader&lt;T&gt;</span>
  </div>
  
  
  
  
  
  <section>
  <h4 class="typeParameters">Type Parameters</h4>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><span class="parametername"><code>T</code></span></dt>
    <dd></dd>
  </dl>
  </section>
  
  
  <h3 id="members">Members</h3>
  <h4>Properties
  </h4>
  <table class="table table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>
          <a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_Completion">Completion</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
    </tbody>
  </table>
  <h4>Methods
  </h4>
  <table class="table table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>
          <a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_ReadAllAsync_CancellationToken_">ReadAllAsync(CancellationToken)</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
      <tr>
        <td>
          <a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_ReadAsync_CancellationToken_">ReadAsync(CancellationToken)</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
      <tr>
        <td>
          <a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_TryRead__0__">TryRead(out T)</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
      <tr>
        <td>
          <a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_WaitToReadAsync_CancellationToken_">WaitToReadAsync(CancellationToken)</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
    </tbody>
  </table>
  
  <h3 id="properties">Properties
  </h3>
  <section>
  <a id="Cysharp_Threading_Tasks_ChannelReader_1_Completion_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.Completion*"></a>
  <h4 id="Cysharp_Threading_Tasks_ChannelReader_1_Completion" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.Completion">Completion</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract UniTask Completion { get; }</code></pre>
  </div>

  
  
  
  
  <section>
  <h5 class="propertyValue">Property Value</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a></dt>
    <dd></dd>
  </dl>
  </section>
  
  
  
  
  
  
  
  
  </section>
  <h3 id="methods">Methods
  </h3>
  <section>
  <a id="Cysharp_Threading_Tasks_ChannelReader_1_ReadAllAsync_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.ReadAllAsync*"></a>
  <h4 id="Cysharp_Threading_Tasks_ChannelReader_1_ReadAllAsync_CancellationToken_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.ReadAllAsync(CancellationToken)">ReadAllAsync(CancellationToken)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract IUniTaskAsyncEnumerable&lt;T&gt; ReadAllAsync(CancellationToken cancellationToken = null)</code></pre>
  </div>

  <section>
  <h5 class="parameters">Parameters</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
    <dd></dd>
  </dl>
  </section>
  
  <section>
  <h5 class="returns">Returns</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><a class="xref" href="Cysharp.Threading.Tasks.IUniTaskAsyncEnumerable-1.html">IUniTaskAsyncEnumerable</a>&lt;T&gt;</dt>
    <dd></dd>
  </dl>
  </section>
  
  
  
  
  
  
  
  
  
  
  
  </section>
  <section>
  <a id="Cysharp_Threading_Tasks_ChannelReader_1_ReadAsync_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.ReadAsync*"></a>
  <h4 id="Cysharp_Threading_Tasks_ChannelReader_1_ReadAsync_CancellationToken_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.ReadAsync(CancellationToken)">ReadAsync(CancellationToken)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public virtual UniTask&lt;T&gt; ReadAsync(CancellationToken cancellationToken = null)</code></pre>
  </div>

  <section>
  <h5 class="parameters">Parameters</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
    <dd></dd>
  </dl>
  </section>
  
  <section>
  <h5 class="returns">Returns</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T&gt;</dt>
    <dd></dd>
  </dl>
  </section>
  
  
  
  
  
  
  
  
  
  
  
  </section>
  <section>
  <a id="Cysharp_Threading_Tasks_ChannelReader_1_TryRead_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.TryRead*"></a>
  <h4 id="Cysharp_Threading_Tasks_ChannelReader_1_TryRead__0__" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.TryRead(`0@)">TryRead(out T)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract bool TryRead(out T item)</code></pre>
  </div>

  <section>
  <h5 class="parameters">Parameters</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><span class="parametername"><code>item</code></span> <span class="xref">T</span></dt>
    <dd></dd>
  </dl>
  </section>
  
  <section>
  <h5 class="returns">Returns</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><span class="xref">System.Boolean</span></dt>
    <dd></dd>
  </dl>
  </section>
  
  
  
  
  
  
  
  
  
  
  
  </section>
  <section>
  <a id="Cysharp_Threading_Tasks_ChannelReader_1_WaitToReadAsync_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.WaitToReadAsync*"></a>
  <h4 id="Cysharp_Threading_Tasks_ChannelReader_1_WaitToReadAsync_CancellationToken_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.WaitToReadAsync(CancellationToken)">WaitToReadAsync(CancellationToken)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract UniTask&lt;bool&gt; WaitToReadAsync(CancellationToken cancellationToken = null)</code></pre>
  </div>

  <section>
  <h5 class="parameters">Parameters</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
    <dd></dd>
  </dl>
  </section>
  
  <section>
  <h5 class="returns">Returns</h5>
  <dl class="cysharpdocfx-valuedefinition">
    <dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;<span class="xref">System.Boolean</span>&gt;</dt>
    <dd></dd>
  </dl>
  </section>
  
  
  
  
  
  
  
  
  
  
  
  </section>
  
  
  
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            Copyright © <a href="https://cysharp.co.jp/">Cysharp</a>, Inc. | <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/docfx.override.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>