mirror of https://github.com/Cysharp/UniTask
544 lines
18 KiB
HTML
544 lines
18 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>UniTaskCompletionSourceCore<TResult> Struct
|
|
| UniTask </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="UniTaskCompletionSourceCore<TResult> Struct
|
|
| UniTask ">
|
|
<meta name="generator" content="docfx 2.59.2.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.UniTaskCompletionSourceCore`1">
|
|
|
|
<h1 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1" class="text-break">UniTaskCompletionSourceCore<TResult> Struct
|
|
</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 struct UniTaskCompletionSourceCore<TResult></code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h4 class="typeParameters">Type Parameters</h4>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="parametername"><code>TResult</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.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_Version">Version</a>
|
|
</td>
|
|
<td class="markdown level1 summary"><p>Gets the operation version.</p>
|
|
</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.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_GetResult_System_Int16_">GetResult(Int16)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"><p>Gets the result of the operation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_GetStatus_System_Int16_">GetStatus(Int16)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"><p>Gets the status of the operation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_OnCompleted_Action_System_Object__System_Object_System_Int16_">OnCompleted(Action<Object>, Object, Int16)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"><p>Schedules the continuation action for this operation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_Reset">Reset()</a>
|
|
</td>
|
|
<td class="markdown level1 summary"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_TrySetCanceled_System_Threading_CancellationToken_">TrySetCanceled(CancellationToken)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_TrySetException_Exception_">TrySetException(Exception)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"><p>Completes with an error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_TrySetResult__0_">TrySetResult(TResult)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"><p>Completes with a successful result.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore-1.html#Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_UnsafeGetStatus">UnsafeGetStatus()</a>
|
|
</td>
|
|
<td class="markdown level1 summary"><p>Gets the status of the operation without token validation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_Version_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.Version*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_Version" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.Version">Version</h4>
|
|
<div class="markdown level1 summary"><p>Gets the operation version.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public readonly short Version { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="xref">System.Int16</span></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_GetResult_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.GetResult*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_GetResult_System_Int16_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.GetResult(System.Int16)">GetResult(Int16)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the result of the operation.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public TResult 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><p>Opaque value that was provided to the <a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a>'s constructor.</p>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
<section>
|
|
<h5 class="returns">Returns</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="xref">TResult</span></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_GetStatus_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.GetStatus*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_GetStatus_System_Int16_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.GetStatus(System.Int16)">GetStatus(Int16)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the status of the operation.</p>
|
|
</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><p>Opaque value that was provided to the <a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a>'s constructor.</p>
|
|
</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_UniTaskCompletionSourceCore_1_OnCompleted_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.OnCompleted*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_OnCompleted_Action_System_Object__System_Object_System_Int16_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.OnCompleted(Action{System.Object},System.Object,System.Int16)">OnCompleted(Action<Object>, Object, Int16)</h4>
|
|
<div class="markdown level1 summary"><p>Schedules the continuation action for this operation.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void OnCompleted(Action<object> 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><<span class="xref">System.Object</span>></dt>
|
|
<dd><p>The continuation to invoke when the operation has completed.</p>
|
|
</dd>
|
|
<dt><span class="parametername"><code>state</code></span> <span class="xref">System.Object</span></dt>
|
|
<dd><p>The state object to pass to <code data-dev-comment-type="paramref" class="paramref">continuation</code> when it's invoked.</p>
|
|
</dd>
|
|
<dt><span class="parametername"><code>token</code></span> <span class="xref">System.Int16</span></dt>
|
|
<dd><p>Opaque value that was provided to the <a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a>'s constructor.</p>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_Reset_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.Reset*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_Reset" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.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_UniTaskCompletionSourceCore_1_TrySetCanceled_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.TrySetCanceled*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_TrySetCanceled_System_Threading_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.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_UniTaskCompletionSourceCore_1_TrySetException_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.TrySetException*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_TrySetException_Exception_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.TrySetException(Exception)">TrySetException(Exception)</h4>
|
|
<div class="markdown level1 summary"><p>Completes with an error.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool TrySetException(Exception error)</code></pre>
|
|
</div>
|
|
|
|
<section>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="parametername"><code>error</code></span> <span class="xref">Exception</span></dt>
|
|
<dd><p>The exception.</p>
|
|
</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_UniTaskCompletionSourceCore_1_TrySetResult_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.TrySetResult*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_TrySetResult__0_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.TrySetResult(`0)">TrySetResult(TResult)</h4>
|
|
<div class="markdown level1 summary"><p>Completes with a successful result.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool TrySetResult(TResult result)</code></pre>
|
|
</div>
|
|
|
|
<section>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="parametername"><code>result</code></span> <span class="xref">TResult</span></dt>
|
|
<dd><p>The result.</p>
|
|
</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_UniTaskCompletionSourceCore_1_UnsafeGetStatus_" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.UnsafeGetStatus*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTaskCompletionSourceCore_1_UnsafeGetStatus" data-uid="Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.UnsafeGetStatus">UnsafeGetStatus()</h4>
|
|
<div class="markdown level1 summary"><p>Gets the status of the operation without token validation.</p>
|
|
</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>
|
|
|
|
|
|
|
|
</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>
|