mirror of https://github.com/Cysharp/UniTask
395 lines
12 KiB
HTML
395 lines
12 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>UniTask.Awaiter Struct
|
|
| UniTask </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="UniTask.Awaiter Struct
|
|
| 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.UniTask.Awaiter">
|
|
|
|
<h1 id="Cysharp_Threading_Tasks_UniTask_Awaiter" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter" class="text-break">UniTask.Awaiter 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 Awaiter : ICriticalNotifyCompletion</code></pre>
|
|
</div>
|
|
|
|
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">ICriticalNotifyCompletion</span></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.UniTask.Awaiter.html#Cysharp_Threading_Tasks_UniTask_Awaiter__ctor_Cysharp_Threading_Tasks_UniTask__">Awaiter(UniTask)</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.UniTask.Awaiter.html#Cysharp_Threading_Tasks_UniTask_Awaiter_IsCompleted">IsCompleted</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.UniTask.Awaiter.html#Cysharp_Threading_Tasks_UniTask_Awaiter_GetResult">GetResult()</a>
|
|
</td>
|
|
<td class="markdown level1 summary"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.Awaiter.html#Cysharp_Threading_Tasks_UniTask_Awaiter_OnCompleted_System_Action_">OnCompleted(Action)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.Awaiter.html#Cysharp_Threading_Tasks_UniTask_Awaiter_SourceOnCompleted_System_Action_System_Object__System_Object_">SourceOnCompleted(Action<Object>, Object)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"><p>If register manually continuation, you can use it instead of for compiler OnCompleted methods.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.Awaiter.html#Cysharp_Threading_Tasks_UniTask_Awaiter_UnsafeOnCompleted_System_Action_">UnsafeOnCompleted(Action)</a>
|
|
</td>
|
|
<td class="markdown level1 summary"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTask_Awaiter__ctor_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.#ctor*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTask_Awaiter__ctor_Cysharp_Threading_Tasks_UniTask__" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.#ctor(Cysharp.Threading.Tasks.UniTask@)">Awaiter(UniTask)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Awaiter(in UniTask task)</code></pre>
|
|
</div>
|
|
|
|
<section>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="parametername"><code>task</code></span> <a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTask_Awaiter_IsCompleted_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.IsCompleted*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTask_Awaiter_IsCompleted" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.IsCompleted">IsCompleted</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsCompleted { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="xref">System.Boolean</span></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTask_Awaiter_GetResult_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.GetResult*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTask_Awaiter_GetResult" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.GetResult">GetResult()</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()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTask_Awaiter_OnCompleted_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.OnCompleted*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTask_Awaiter_OnCompleted_System_Action_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.OnCompleted(System.Action)">OnCompleted(Action)</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 continuation)</code></pre>
|
|
</div>
|
|
|
|
<section>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="parametername"><code>continuation</code></span> <span class="xref">System.Action</span></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTask_Awaiter_SourceOnCompleted_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.SourceOnCompleted*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTask_Awaiter_SourceOnCompleted_System_Action_System_Object__System_Object_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.SourceOnCompleted(System.Action{System.Object},System.Object)">SourceOnCompleted(Action<Object>, Object)</h4>
|
|
<div class="markdown level1 summary"><p>If register manually continuation, you can use it instead of for compiler OnCompleted methods.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SourceOnCompleted(Action<object> continuation, object state)</code></pre>
|
|
</div>
|
|
|
|
<section>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="parametername"><code>continuation</code></span> <span class="xref">System.Action</span><<span class="xref">System.Object</span>></dt>
|
|
<dd></dd>
|
|
<dt><span class="parametername"><code>state</code></span> <span class="xref">System.Object</span></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
<section>
|
|
<a id="Cysharp_Threading_Tasks_UniTask_Awaiter_UnsafeOnCompleted_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.UnsafeOnCompleted*"></a>
|
|
<h4 id="Cysharp_Threading_Tasks_UniTask_Awaiter_UnsafeOnCompleted_System_Action_" data-uid="Cysharp.Threading.Tasks.UniTask.Awaiter.UnsafeOnCompleted(System.Action)">UnsafeOnCompleted(Action)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void UnsafeOnCompleted(Action continuation)</code></pre>
|
|
</div>
|
|
|
|
<section>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<dl class="cysharpdocfx-valuedefinition">
|
|
<dt><span class="parametername"><code>continuation</code></span> <span class="xref">System.Action</span></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">ICriticalNotifyCompletion</span>
|
|
</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>
|