239 lines
13 KiB
XML
239 lines
13 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>UniTask</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Cysharp.Threading.Tasks.UniTask">
|
|
<summary>
|
|
Lightweight unity specified task-like object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Run(System.Action,System.Boolean)">
|
|
<summary>Run action on the threadPool and return to current SynchronizationContext if configureAwait = true.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Run(System.Action{System.Object},System.Object,System.Boolean)">
|
|
<summary>Run action on the threadPool and return to current SynchronizationContext if configureAwait = true.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Run``1(System.Func{``0},System.Boolean)">
|
|
<summary>Run action on the threadPool and return to current SynchronizationContext if configureAwait = true.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Run``1(System.Func{System.Object,``0},System.Object,System.Boolean)">
|
|
<summary>Run action on the threadPool and return to current SynchronizationContext if configureAwait = true.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.SuppressCancellationThrow">
|
|
<summary>
|
|
returns (bool IsCanceled) instead of throws OperationCanceledException.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Preserve">
|
|
<summary>
|
|
Memoizing inner IValueTaskSource. The result UniTask can await multiple.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Awaiter.SourceOnCompleted(System.Action{System.Object},System.Object)">
|
|
<summary>
|
|
If register manually continuation, you can use it instead of for compiler OnCompleted methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Void(System.Func{Cysharp.Threading.Tasks.UniTaskVoid})">
|
|
<summary>
|
|
helper of fire and forget void action.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Void(System.Func{System.Threading.CancellationToken,Cysharp.Threading.Tasks.UniTaskVoid},System.Threading.CancellationToken)">
|
|
<summary>
|
|
helper of fire and forget void action.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Void``1(System.Func{``0,Cysharp.Threading.Tasks.UniTaskVoid},``0)">
|
|
<summary>
|
|
helper of fire and forget void action.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Action(System.Func{Cysharp.Threading.Tasks.UniTaskVoid})">
|
|
<summary>
|
|
helper of create add UniTaskVoid to delegate.
|
|
For example: FooAction = UniTask.Action(async () => { /* */ })
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Action(System.Func{System.Threading.CancellationToken,Cysharp.Threading.Tasks.UniTaskVoid},System.Threading.CancellationToken)">
|
|
<summary>
|
|
helper of create add UniTaskVoid to delegate.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Action``1(``0,System.Func{``0,Cysharp.Threading.Tasks.UniTaskVoid})">
|
|
<summary>
|
|
helper of create add UniTaskVoid to delegate.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Defer(System.Func{Cysharp.Threading.Tasks.UniTask})">
|
|
<summary>
|
|
Defer the task creation just before call await.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Defer``1(System.Func{Cysharp.Threading.Tasks.UniTask{``0}})">
|
|
<summary>
|
|
Defer the task creation just before call await.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Defer``1(``0,System.Func{``0,Cysharp.Threading.Tasks.UniTask})">
|
|
<summary>
|
|
Defer the task creation just before call await.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Defer``2(``0,System.Func{``0,Cysharp.Threading.Tasks.UniTask{``1}})">
|
|
<summary>
|
|
Defer the task creation just before call await.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Never(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Never complete.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.Never``1(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Never complete.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.SwitchToTaskPool">
|
|
<summary>
|
|
Note: use SwitchToThreadPool is recommended.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.WhenAny(Cysharp.Threading.Tasks.UniTask[])">
|
|
<summary>Return value is winArgumentIndex</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask.WhenAny(System.Collections.Generic.IEnumerable{Cysharp.Threading.Tasks.UniTask})">
|
|
<summary>Return value is winArgumentIndex</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.Internal.ArrayUtil.Materialize``1(System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Optimizing utility to avoid .ToArray() that creates buffer copy(cut to just size).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.TaskTracker.ForEachActiveTask(System.Action{System.Int32,System.String,Cysharp.Threading.Tasks.UniTaskStatus,System.DateTime,System.String})">
|
|
<summary>(trackingId, awaiterType, awaiterStatus, createdTime, stackTrace)</summary>
|
|
</member>
|
|
<member name="F:Cysharp.Threading.Tasks.UniTaskStatus.Pending">
|
|
<summary>The operation has not yet completed.</summary>
|
|
</member>
|
|
<member name="F:Cysharp.Threading.Tasks.UniTaskStatus.Succeeded">
|
|
<summary>The operation completed successfully.</summary>
|
|
</member>
|
|
<member name="F:Cysharp.Threading.Tasks.UniTaskStatus.Faulted">
|
|
<summary>The operation completed with an error.</summary>
|
|
</member>
|
|
<member name="F:Cysharp.Threading.Tasks.UniTaskStatus.Canceled">
|
|
<summary>The operation completed due to cancellation.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskStatusExtensions.IsCompleted(Cysharp.Threading.Tasks.UniTaskStatus)">
|
|
<summary>status != Pending.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskStatusExtensions.IsCompletedSuccessfully(Cysharp.Threading.Tasks.UniTaskStatus)">
|
|
<summary>status == Succeeded.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskStatusExtensions.IsCanceled(Cysharp.Threading.Tasks.UniTaskStatus)">
|
|
<summary>status == Canceled.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskStatusExtensions.IsFaulted(Cysharp.Threading.Tasks.UniTaskStatus)">
|
|
<summary>status == Faulted.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.Linq.UniTaskAsyncEnumerable.ForEachAsync``1(Cysharp.Threading.Tasks.IUniTaskAsyncEnumerable{``0},System.Func{``0,Cysharp.Threading.Tasks.UniTask},System.Threading.CancellationToken)">
|
|
<summary>Obsolete(Error), Use Use ForEachAwaitAsync instead.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.Linq.UniTaskAsyncEnumerable.ForEachAsync``1(Cysharp.Threading.Tasks.IUniTaskAsyncEnumerable{``0},System.Func{``0,System.Int32,Cysharp.Threading.Tasks.UniTask},System.Threading.CancellationToken)">
|
|
<summary>Obsolete(Error), Use Use ForEachAwaitAsync instead.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.Linq.AsyncEnumeratorBase`2.TryMoveNextCore(System.Boolean,System.Boolean@)">
|
|
<summary>
|
|
If return value is false, continue source.MoveNext.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Cysharp.Threading.Tasks.Progress">
|
|
<summary>
|
|
Lightweight IProgress[T] factory.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Cysharp.Threading.Tasks.UniTask`1">
|
|
<summary>
|
|
Lightweight unity specified task-like object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask`1.Preserve">
|
|
<summary>
|
|
Memoizing inner IValueTaskSource. The result UniTask can await multiple.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask`1.SuppressCancellationThrow">
|
|
<summary>
|
|
returns (bool IsCanceled, T Result) instead of throws OperationCanceledException.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTask`1.Awaiter.SourceOnCompleted(System.Action{System.Object},System.Object)">
|
|
<summary>
|
|
If register manually continuation, you can use it instead of for compiler OnCompleted methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.TrySetResult(`0)">
|
|
<summary>Completes with a successful result.</summary>
|
|
<param name="result">The result.</param>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.TrySetException(System.Exception)">
|
|
<summary>Completes with an error.</summary>
|
|
<param name="error">The exception.</param>
|
|
</member>
|
|
<member name="P:Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.Version">
|
|
<summary>Gets the operation version.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.GetStatus(System.Int16)">
|
|
<summary>Gets the status of the operation.</summary>
|
|
<param name="token">Opaque value that was provided to the <see cref="T:Cysharp.Threading.Tasks.UniTask"/>'s constructor.</param>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.UnsafeGetStatus">
|
|
<summary>Gets the status of the operation without token validation.</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.GetResult(System.Int16)">
|
|
<summary>Gets the result of the operation.</summary>
|
|
<param name="token">Opaque value that was provided to the <see cref="T:Cysharp.Threading.Tasks.UniTask"/>'s constructor.</param>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskCompletionSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16)">
|
|
<summary>Schedules the continuation action for this operation.</summary>
|
|
<param name="continuation">The continuation to invoke when the operation has completed.</param>
|
|
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
|
|
<param name="token">Opaque value that was provided to the <see cref="T:Cysharp.Threading.Tasks.UniTask"/>'s constructor.</param>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskExtensions.AsUniTask``1(System.Threading.Tasks.Task{``0},System.Boolean)">
|
|
<summary>
|
|
Convert Task[T] -> UniTask[T].
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskExtensions.AsUniTask(System.Threading.Tasks.Task,System.Boolean)">
|
|
<summary>
|
|
Convert Task -> UniTask.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskExtensions.AttachExternalCancellation(Cysharp.Threading.Tasks.UniTask,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Ignore task result when cancel raised first.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskExtensions.AttachExternalCancellation``1(Cysharp.Threading.Tasks.UniTask{``0},System.Threading.CancellationToken)">
|
|
<summary>
|
|
Ignore task result when cancel raised first.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cysharp.Threading.Tasks.UniTaskObservableExtensions.ToObservable(Cysharp.Threading.Tasks.UniTask)">
|
|
<summary>
|
|
Ideally returns IObservabl[Unit] is best but Cysharp.Threading.Tasks does not have Unit so return AsyncUnit instead.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Cysharp.Threading.Tasks.UniTaskScheduler.PropagateOperationCanceledException">
|
|
<summary>
|
|
Propagate OperationCanceledException to UnobservedTaskException when true. Default is false.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|