UniTask/api/Cysharp.Threading.Tasks.Uni...

607 lines
19 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>UniTaskCompletionSource Class
| UniTask </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="UniTaskCompletionSource 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.UniTaskCompletionSource">
<h1 id="Cysharp_Threading_Tasks_UniTaskCompletionSource" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource" class="text-break">UniTaskCompletionSource 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 class UniTaskCompletionSource : IUniTaskSource, IValueTaskSource, IPromise, IResolvePromise, IRejectPromise, ICancelPromise</code></pre>
</div>
<div class="inheritance">
<h5>Inheritance</h5>
<span><span class="xref">System.Object</span></span>
<span class="xref">UniTaskCompletionSource</span>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Cysharp.Threading.Tasks.IUniTaskSource.html">IUniTaskSource</a></div>
<div><span class="xref">System.Threading.Tasks.Sources.IValueTaskSource</span></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.IPromise.html">IPromise</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.IResolvePromise.html">IResolvePromise</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.IRejectPromise.html">IRejectPromise</a></div>
<div><a class="xref" href="Cysharp.Threading.Tasks.ICancelPromise.html">ICancelPromise</a></div>
</div>
<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.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource__ctor">UniTaskCompletionSource()</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
</tbody>
</table>
<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.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_Task">Task</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.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_Finalize">Finalize()</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_GetResult_System_Int16_">GetResult(Int16)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_GetStatus_System_Int16_">GetStatus(Int16)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_OnCompleted_Action_System_Object__System_Object_System_Int16_">OnCompleted(Action&lt;Object&gt;, Object, Int16)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_Reset">Reset()</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_TrySetCanceled_System_Threading_CancellationToken_">TrySetCanceled(CancellationToken)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_TrySetException_Exception_">TrySetException(Exception)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_TrySetResult">TrySetResult()</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSource.html#Cysharp_Threading_Tasks_UniTaskCompletionSource_UnsafeGetStatus">UnsafeGetStatus()</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
</tbody>
</table>
<h3 id="constructors">Constructors
</h3>
<section>
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSource__ctor_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.#ctor*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource__ctor" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.#ctor">UniTaskCompletionSource()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UniTaskCompletionSource()</code></pre>
</div>
</section>
<h3 id="properties">Properties
</h3>
<section>
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSource_Task_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.Task*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_Task" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.Task">Task</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UniTask Task { 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_UniTaskCompletionSource_Finalize_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.Finalize*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_Finalize" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.Finalize">Finalize()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected void Finalize()</code></pre>
</div>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSource_GetResult_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.GetResult*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_GetResult_System_Int16_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.GetResult(System.Int16)">GetResult(Int16)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void GetResult(short token)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>token</code></span> <span class="xref">System.Int16</span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSource_GetStatus_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.GetStatus*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_GetStatus_System_Int16_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.GetStatus(System.Int16)">GetStatus(Int16)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UniTaskStatus GetStatus(short token)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>token</code></span> <span class="xref">System.Int16</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTaskStatus.html">UniTaskStatus</a></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSource_OnCompleted_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.OnCompleted*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_OnCompleted_Action_System_Object__System_Object_System_Int16_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.OnCompleted(Action{System.Object},System.Object,System.Int16)">OnCompleted(Action&lt;Object&gt;, Object, Int16)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void OnCompleted(Action&lt;object&gt; continuation, object state, short token)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>continuation</code></span> <span class="xref">Action</span>&lt;<span class="xref">System.Object</span>&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>state</code></span> <span class="xref">System.Object</span></dt>
<dd></dd>
<dt><span class="parametername"><code>token</code></span> <span class="xref">System.Int16</span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSource_Reset_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.Reset*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_Reset" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.Reset">Reset()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Reset()</code></pre>
</div>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSource_TrySetCanceled_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.TrySetCanceled*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_TrySetCanceled_System_Threading_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.TrySetCanceled(System.Threading.CancellationToken)">TrySetCanceled(CancellationToken)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool TrySetCanceled(CancellationToken cancellationToken = default(CancellationToken))</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">System.Threading.CancellationToken</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_UniTaskCompletionSource_TrySetException_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.TrySetException*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_TrySetException_Exception_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.TrySetException(Exception)">TrySetException(Exception)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool TrySetException(Exception exception)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>exception</code></span> <span class="xref">Exception</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_UniTaskCompletionSource_TrySetResult_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.TrySetResult*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_TrySetResult" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.TrySetResult">TrySetResult()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool TrySetResult()</code></pre>
</div>
<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_UniTaskCompletionSource_UnsafeGetStatus_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.UnsafeGetStatus*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSource_UnsafeGetStatus" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSource.UnsafeGetStatus">UnsafeGetStatus()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UniTaskStatus UnsafeGetStatus()</code></pre>
</div>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTaskStatus.html">UniTaskStatus</a></dt>
<dd></dd>
</dl>
</section>
</section>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Cysharp.Threading.Tasks.IUniTaskSource.html">IUniTaskSource</a>
</div>
<div>
<span class="xref">System.Threading.Tasks.Sources.IValueTaskSource</span>
</div>
<div>
<a class="xref" href="Cysharp.Threading.Tasks.IPromise.html">IPromise</a>
</div>
<div>
<a class="xref" href="Cysharp.Threading.Tasks.IResolvePromise.html">IResolvePromise</a>
</div>
<div>
<a class="xref" href="Cysharp.Threading.Tasks.IRejectPromise.html">IRejectPromise</a>
</div>
<div>
<a class="xref" href="Cysharp.Threading.Tasks.ICancelPromise.html">ICancelPromise</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">
<!-- <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>