UniTask/api/Cysharp.Threading.Tasks.Com...

487 lines
17 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>AsyncUniTaskMethodBuilder&lt;T&gt; Struct
| UniTask </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="AsyncUniTaskMethodBuilder&lt;T&gt; 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.CompilerServices.AsyncUniTaskMethodBuilder`1">
<h1 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1" class="text-break">AsyncUniTaskMethodBuilder&lt;T&gt; Struct
</h1>
<h6><strong>Namespace</strong>: <a class="xref" href="Cysharp.Threading.Tasks.CompilerServices.html">Cysharp.Threading.Tasks.CompilerServices</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 AsyncUniTaskMethodBuilder&lt;T&gt;</code></pre>
</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.CompilerServices.AsyncUniTaskMethodBuilder-1.html#Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_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.CompilerServices.AsyncUniTaskMethodBuilder-1.html#Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_AwaitOnCompleted__2___0____1__">AwaitOnCompleted&lt;TAwaiter, TStateMachine&gt;(ref TAwaiter, ref TStateMachine)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder-1.html#Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_AwaitUnsafeOnCompleted__2___0____1__">AwaitUnsafeOnCompleted&lt;TAwaiter, TStateMachine&gt;(ref TAwaiter, ref TStateMachine)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder-1.html#Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_Create">Create()</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder-1.html#Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetException_Exception_">SetException(Exception)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder-1.html#Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetResult__0_">SetResult(T)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder-1.html#Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetStateMachine_System_Runtime_CompilerServices_IAsyncStateMachine_">SetStateMachine(IAsyncStateMachine)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder-1.html#Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_Start__1___0__">Start&lt;TStateMachine&gt;(ref TStateMachine)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<section>
<a id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_Task_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.Task*"></a>
<h4 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_Task" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.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 readonly UniTask&lt;T&gt; 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-1.html">UniTask</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
</section>
</section>
<h3 id="methods">Methods
</h3>
<section>
<a id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_AwaitOnCompleted_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.AwaitOnCompleted*"></a>
<h4 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_AwaitOnCompleted__2___0____1__" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.AwaitOnCompleted``2(``0@,``1@)">AwaitOnCompleted&lt;TAwaiter, TStateMachine&gt;(ref TAwaiter, ref TStateMachine)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AwaitOnCompleted&lt;TAwaiter, TStateMachine&gt;(ref TAwaiter awaiter, ref TStateMachine stateMachine)
where TAwaiter : INotifyCompletion where TStateMachine : IAsyncStateMachine</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>awaiter</code></span> <span class="xref">TAwaiter</span></dt>
<dd></dd>
<dt><span class="parametername"><code>stateMachine</code></span> <span class="xref">TStateMachine</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>TAwaiter</code></span></dt>
<dd></dd>
<dt><span class="parametername"><code>TStateMachine</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_AwaitUnsafeOnCompleted_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.AwaitUnsafeOnCompleted*"></a>
<h4 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_AwaitUnsafeOnCompleted__2___0____1__" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.AwaitUnsafeOnCompleted``2(``0@,``1@)">AwaitUnsafeOnCompleted&lt;TAwaiter, TStateMachine&gt;(ref TAwaiter, ref TStateMachine)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AwaitUnsafeOnCompleted&lt;TAwaiter, TStateMachine&gt;(ref TAwaiter awaiter, ref TStateMachine stateMachine)
where TAwaiter : ICriticalNotifyCompletion where TStateMachine : IAsyncStateMachine</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>awaiter</code></span> <span class="xref">TAwaiter</span></dt>
<dd></dd>
<dt><span class="parametername"><code>stateMachine</code></span> <span class="xref">TStateMachine</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>TAwaiter</code></span></dt>
<dd></dd>
<dt><span class="parametername"><code>TStateMachine</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_Create_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.Create*"></a>
<h4 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_Create" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.Create">Create()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static AsyncUniTaskMethodBuilder&lt;T&gt; Create()</code></pre>
</div>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder-1.html">AsyncUniTaskMethodBuilder</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetException_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.SetException*"></a>
<h4 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetException_Exception_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.SetException(Exception)">SetException(Exception)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetException(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>
<section>
<a id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetResult_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.SetResult*"></a>
<h4 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetResult__0_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.SetResult(`0)">SetResult(T)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetResult(T 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">T</span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetStateMachine_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.SetStateMachine*"></a>
<h4 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_SetStateMachine_System_Runtime_CompilerServices_IAsyncStateMachine_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.SetStateMachine(System.Runtime.CompilerServices.IAsyncStateMachine)">SetStateMachine(IAsyncStateMachine)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetStateMachine(IAsyncStateMachine stateMachine)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>stateMachine</code></span> <span class="xref">System.Runtime.CompilerServices.IAsyncStateMachine</span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_Start_" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.Start*"></a>
<h4 id="Cysharp_Threading_Tasks_CompilerServices_AsyncUniTaskMethodBuilder_1_Start__1___0__" data-uid="Cysharp.Threading.Tasks.CompilerServices.AsyncUniTaskMethodBuilder`1.Start``1(``0@)">Start&lt;TStateMachine&gt;(ref TStateMachine)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Start&lt;TStateMachine&gt;(ref TStateMachine stateMachine)
where TStateMachine : IAsyncStateMachine</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>stateMachine</code></span> <span class="xref">TStateMachine</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>TStateMachine</code></span></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>