mirror of
https://github.com/Cysharp/UniTask.git
synced 2026-05-17 20:50:11 +00:00
deploy: dce4366f3e
This commit is contained in:
guitarrapc
@@ -1,16 +1,16 @@
|
||||
<!DOCTYPE html>
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>ChannelReader<T> Class
|
||||
| UniTask </title>
|
||||
| UniTask </title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="ChannelReader<T> Class
|
||||
| UniTask ">
|
||||
<meta name="generator" content="docfx 2.59.2.0">
|
||||
|
||||
| UniTask ">
|
||||
<meta name="generator" content="docfx ">
|
||||
|
||||
<link rel="shortcut icon" href="../img/favicon.ico">
|
||||
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
||||
<link rel="stylesheet" href="../styles/docfx.css">
|
||||
@@ -18,14 +18,14 @@
|
||||
<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">
|
||||
@@ -35,7 +35,7 @@
|
||||
<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="">
|
||||
@@ -52,7 +52,7 @@
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="subnav navbar navbar-default">
|
||||
<div class="container hide-when-search" id="breadcrumb">
|
||||
<ul class="breadcrumb">
|
||||
@@ -62,7 +62,7 @@
|
||||
</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">
|
||||
@@ -72,29 +72,29 @@
|
||||
<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<T> 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>
|
||||
|
||||
</h1>
|
||||
<h6><strong>Namespace</strong>: <a class="xref" href="Cysharp.html">Cysharp</a>.<a class="xref" href="Cysharp.Threading.html">Threading</a>.<a class="xref" href="Cysharp.Threading.Tasks.html">Tasks</a></h6>
|
||||
<h6><strong>Assembly</strong>: UniTask.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<T></code></pre>
|
||||
<pre><code class="lang- hljs">public abstract class ChannelReader<T></code></pre>
|
||||
</div>
|
||||
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<span><span class="xref">System.Object</span></span> →
|
||||
<span><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></span> →
|
||||
<span class="xref">ChannelReader<T></span>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<h4 class="typeParameters">Type Parameters</h4>
|
||||
<dl class="cysharpdocfx-valuedefinition">
|
||||
@@ -102,11 +102,29 @@
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="members">Members</h3>
|
||||
<h4>Constructors
|
||||
</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__ctor">ChannelReader()</a>
|
||||
</td>
|
||||
<td class="markdown level1 summary"></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Properties
|
||||
</h4>
|
||||
</h4>
|
||||
<table class="table table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -124,7 +142,7 @@
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Methods
|
||||
</h4>
|
||||
</h4>
|
||||
<table class="table table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -135,13 +153,13 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_ReadAllAsync_CancellationToken_">ReadAllAsync(CancellationToken)</a>
|
||||
<a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_ReadAllAsync_System_Threading_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>
|
||||
<a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_ReadAsync_System_Threading_CancellationToken_">ReadAsync(CancellationToken)</a>
|
||||
</td>
|
||||
<td class="markdown level1 summary"></td>
|
||||
</tr>
|
||||
@@ -153,29 +171,54 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_WaitToReadAsync_CancellationToken_">WaitToReadAsync(CancellationToken)</a>
|
||||
<a class="xref" href="Cysharp.Threading.Tasks.ChannelReader-1.html#Cysharp_Threading_Tasks_ChannelReader_1_WaitToReadAsync_System_Threading_CancellationToken_">WaitToReadAsync(CancellationToken)</a>
|
||||
</td>
|
||||
<td class="markdown level1 summary"></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
<section>
|
||||
<a id="Cysharp_Threading_Tasks_ChannelReader_1__ctor_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.#ctor*"></a>
|
||||
<h4 id="Cysharp_Threading_Tasks_ChannelReader_1__ctor" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.#ctor">ChannelReader()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang- hljs">protected ChannelReader()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
</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>
|
||||
<pre><code class="lang- hljs">public abstract UniTask Completion { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<h5 class="propertyValue">Property Value</h5>
|
||||
<dl class="cysharpdocfx-valuedefinition">
|
||||
@@ -183,35 +226,35 @@
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
</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>
|
||||
<h4 id="Cysharp_Threading_Tasks_ChannelReader_1_ReadAllAsync_System_Threading_CancellationToken_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.ReadAllAsync(System.Threading.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<T> ReadAllAsync(CancellationToken cancellationToken = null)</code></pre>
|
||||
<pre><code class="lang- hljs">public abstract IUniTaskAsyncEnumerable<T> ReadAllAsync(CancellationToken cancellationToken = default)</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>
|
||||
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
<section>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<dl class="cysharpdocfx-valuedefinition">
|
||||
@@ -219,36 +262,36 @@
|
||||
<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>
|
||||
<h4 id="Cysharp_Threading_Tasks_ChannelReader_1_ReadAsync_System_Threading_CancellationToken_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.ReadAsync(System.Threading.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<T> ReadAsync(CancellationToken cancellationToken = null)</code></pre>
|
||||
<pre><code class="lang- hljs">public virtual UniTask<T> ReadAsync(CancellationToken cancellationToken = default)</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>
|
||||
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
<section>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<dl class="cysharpdocfx-valuedefinition">
|
||||
@@ -256,26 +299,26 @@
|
||||
<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>
|
||||
<pre><code class="lang- hljs">public abstract bool TryRead(out T item)</code></pre>
|
||||
</div>
|
||||
|
||||
<section>
|
||||
@@ -285,69 +328,73 @@
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
<section>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<dl class="cysharpdocfx-valuedefinition">
|
||||
<dt><span class="xref">System.Boolean</span></dt>
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></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>
|
||||
<h4 id="Cysharp_Threading_Tasks_ChannelReader_1_WaitToReadAsync_System_Threading_CancellationToken_" data-uid="Cysharp.Threading.Tasks.ChannelReader`1.WaitToReadAsync(System.Threading.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<bool> WaitToReadAsync(CancellationToken cancellationToken = null)</code></pre>
|
||||
<pre><code class="lang- hljs">public abstract UniTask<bool> WaitToReadAsync(CancellationToken cancellationToken = default)</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>
|
||||
<dt><span class="parametername"><code>cancellationToken</code></span> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></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><<span class="xref">System.Boolean</span>></dt>
|
||||
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="extensionmethods">Extension Methods</h3>
|
||||
<div>
|
||||
<a class="xref" href="FluentAssertions.FluentAssertionsExtensions.html#FluentAssertions_FluentAssertionsExtensions_Should__1___0_">FluentAssertionsExtensions.Should<T>(T)</a>
|
||||
</div>
|
||||
|
||||
</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">
|
||||
@@ -357,20 +404,20 @@
|
||||
</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>
|
||||
|
||||
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>
|
||||
|
||||
Reference in New Issue
Block a user