Skip to content
This repository has been archived by the owner on Feb 16, 2024. It is now read-only.

UniRx.Async

Jump to bottom
Yoshifumi Kawai edited this page Jul 22, 2018 · 1 revision

AsyncUnit

public struct UniRx.Async.AsyncUnit
    : IEquatable<AsyncUnit>

Methods

Type Name Summary
Boolean Equals(AsyncUnit other)
Int32 GetHashCode()

Static Fields

Type Name Summary
AsyncUnit Default

AsyncUnityEventHandler

public class UniRx.Async.AsyncUnityEventHandler
    : IAwaiter<AsyncUnit>, IAwaiter, ICriticalNotifyCompletion, INotifyCompletion, IDisposable, IAsyncClickEventHandler

Methods

Type Name Summary
void Dispose()
AsyncUnit GetResult()
UniTask OnInvokeAsync()

AsyncUnityEventHandler<T>

public class UniRx.Async.AsyncUnityEventHandler<T>
    : IAwaiter<T>, IAwaiter, ICriticalNotifyCompletion, INotifyCompletion, IDisposable, IAsyncValueChangedEventHandler<T>, IAsyncEndEditEventHandler<T>

Methods

Type Name Summary
void Dispose()
UniTask<T> OnInvokeAsync()

CancellationTokenExtensions

public static class UniRx.Async.CancellationTokenExtensions

Static Methods

Type Name Summary
ValueTuple<UniTask, CancellationTokenRegistration> ToUniTask(this CancellationToken cts)

EnumeratorAsyncExtensions

public static class UniRx.Async.EnumeratorAsyncExtensions

Static Methods

Type Name Summary
UniTask ConfigureAwait(this IEnumerator enumerator, PlayerLoopTiming timing = Update, CancellationToken cancellationToken = null)
Awaiter GetAwaiter(this IEnumerator enumerator)
UniTask ToUniTask(this IEnumerator enumerator)

IAsyncClickEventHandler

public interface UniRx.Async.IAsyncClickEventHandler
    : IDisposable

Methods

Type Name Summary
UniTask OnClickAsync()

IAsyncEndEditEventHandler<T>

public interface UniRx.Async.IAsyncEndEditEventHandler<T>
    : IDisposable

Methods

Type Name Summary
UniTask<T> OnEndEditAsync()

IAsyncValueChangedEventHandler<T>

public interface UniRx.Async.IAsyncValueChangedEventHandler<T>
    : IDisposable

Methods

Type Name Summary
UniTask<T> OnValueChangedAsync()

IAwaiter

public interface UniRx.Async.IAwaiter
    : ICriticalNotifyCompletion, INotifyCompletion

Properties

Type Name Summary
Boolean IsCompleted

Methods

Type Name Summary
void GetResult()

IAwaiter<T>

public interface UniRx.Async.IAwaiter<T>
    : IAwaiter, ICriticalNotifyCompletion, INotifyCompletion

Methods

Type Name Summary
T GetResult()

IPlayerLoopItem

public interface UniRx.Async.IPlayerLoopItem

Methods

Type Name Summary
Boolean MoveNext()

PlayerLoopHelper

public static class UniRx.Async.PlayerLoopHelper

Static Methods

Type Name Summary
void AddAction(PlayerLoopTiming timing, IPlayerLoopItem action)
void Initialize(PlayerLoopSystem& playerLoop)

PlayerLoopTiming

public enum UniRx.Async.PlayerLoopTiming
    : Enum, IComparable, IFormattable, IConvertible

Enum

Value Name Summary
0 Initialization
1 EarlyUpdate
2 FixedUpdate
3 PreUpdate
4 Update
5 PreLateUpdate
6 PostLateUpdate

Progress

Lightweight IProgress[T] factory.

public static class UniRx.Async.Progress

Static Methods

Type Name Summary
IProgress<T> Create(Action<T> handler)

UniTask

Lightweight unity specified task-like object.

public struct UniRx.Async.UniTask
    : IEquatable<UniTask>

Properties

Type Name Summary
Boolean IsCompleted

Methods

Type Name Summary
Boolean Equals(UniTask other)
Awaiter GetAwaiter()
Int32 GetHashCode()
void GetResult()

Static Properties

Type Name Summary
UniTask CompletedTask

Static Methods

Type Name Summary
UniTask Delay(Int32 millisecondsDelay, Boolean ignoreTimeScale = False, PlayerLoopTiming delayTiming = Update, CancellationToken cancellationToken = null)
UniTask Delay(TimeSpan delayTimeSpan, Boolean ignoreTimeScale = False, PlayerLoopTiming delayTiming = Update, CancellationToken cancellationToken = null)
UniTask<Int32> DelayFrame(Int32 delayFrameCount, PlayerLoopTiming delayTiming = Update, CancellationToken cancellationToken = null)
UniTask FromCanceled()
UniTask<T> FromCanceled()
UniTask FromCanceled(CancellationToken token)
UniTask<T> FromCanceled(CancellationToken token)
UniTask FromException(Exception ex)
UniTask<T> FromException(Exception ex)
UniTask<T> FromResult(T value)
UniTask SwitchToTaskPool(CancellationToken cancellationToken = null)
UniTask SwitchToThreadPool()
UniTask WaitUntil(Func<Boolean> predicate, PlayerLoopTiming timing = Update, CancellationToken cancellationToken = null)
UniTask<U> WaitUntilValueChanged(T target, Func<T, U> monitorFunction, PlayerLoopTiming monitorTiming = Update, IEqualityComparer<U> equalityComparer = null, CancellationToken cancellationToken = null)
UniTask<ValueTuple<Boolean, U>> WaitUntilValueChangedWithIsDestroyed(T target, Func<T, U> monitorFunction, PlayerLoopTiming monitorTiming = Update, IEqualityComparer<U> equalityComparer = null, CancellationToken cancellationToken = null)
UniTask WaitWhile(Func<Boolean> predicate, PlayerLoopTiming timing = Update, CancellationToken cancellationToken = null)
UniTask<T[]> WhenAll(UniTask1[]` tasks)
UniTask<T[]> WhenAll(IEnumerable<UniTask<T>> tasks)
UniTask WhenAll(UniTask[] tasks)
UniTask WhenAll(IEnumerable<UniTask> tasks)
UniTask<ValueTuple<T1, T2>> WhenAll(UniTask<T1> task1, UniTask<T2> task2)
UniTask<ValueTuple<T1, T2, T3>> WhenAll(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3)
UniTask<ValueTuple<T1, T2, T3, T4>> WhenAll(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4)
UniTask<ValueTuple<T1, T2, T3, T4, T5>> WhenAll(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5)
UniTask<ValueTuple<T1, T2, T3, T4, T5, T6>> WhenAll(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6)
UniTask<ValueTuple<T1, T2, T3, T4, T5, T6, T7>> WhenAll(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7)
UniTask<ValueTuple<Boolean, T0>> WhenAny(UniTask<T0> task0, UniTask task1)
UniTask<ValueTuple<Int32, T>> WhenAny(UniTask1[]` tasks)
UniTask<Int32> WhenAny(UniTask[] tasks)
UniTask<ValueTuple<Int32, ValueTuple<Boolean, T0>, ValueTuple<Boolean, T1>>> WhenAny(UniTask<T0> task0, UniTask<T1> task1)
UniTask<ValueTuple<Int32, ValueTuple<Boolean, T0>, ValueTuple<Boolean, T1>, ValueTuple<Boolean, T2>>> WhenAny(UniTask<T0> task0, UniTask<T1> task1, UniTask<T2> task2)
UniTask<ValueTuple<Int32, ValueTuple<Boolean, T0>, ValueTuple<Boolean, T1>, ValueTuple<Boolean, T2>, ValueTuple<Boolean, T3>>> WhenAny(UniTask<T0> task0, UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3)
UniTask<ValueTuple<Int32, ValueTuple<Boolean, T0>, ValueTuple<Boolean, T1>, ValueTuple<Boolean, T2>, ValueTuple<Boolean, T3>, ValueTuple<Boolean, T4>>> WhenAny(UniTask<T0> task0, UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4)
UniTask<ValueTuple<Int32, ValueTuple<Boolean, T0>, ValueTuple<Boolean, T1>, ValueTuple<Boolean, T2>, ValueTuple<Boolean, T3>, ValueTuple<Boolean, T4>, ValueTuple<Boolean, T5>>> WhenAny(UniTask<T0> task0, UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5)
UniTask<ValueTuple<Int32, ValueTuple<Boolean, T0>, ValueTuple<Boolean, T1>, ValueTuple<Boolean, T2>, ValueTuple<Boolean, T3>, ValueTuple<Boolean, T4>, ValueTuple<Boolean, T5>, ValueTuple<ValueTuple<Boolean, T6>>>> WhenAny(UniTask<T0> task0, UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6)
UniTask<ValueTuple<Int32, ValueTuple<Boolean, T0>, ValueTuple<Boolean, T1>, ValueTuple<Boolean, T2>, ValueTuple<Boolean, T3>, ValueTuple<Boolean, T4>, ValueTuple<Boolean, T5>, ValueTuple<ValueTuple<Boolean, T6>, ValueTuple<Boolean, T7>>>> WhenAny(UniTask<T0> task0, UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7)
UniTask Yield(PlayerLoopTiming timing = Update, CancellationToken cancellationToken = null)

UniTask<T>

Lightweight unity specified task-like object.

public struct UniRx.Async.UniTask<T>
    : IEquatable<UniTask<T>>

Properties

Type Name Summary
Boolean IsCompleted
T Result

Methods

Type Name Summary
Boolean Equals(UniTask<T> other)
Awaiter<T> GetAwaiter()
Int32 GetHashCode()

UniTaskCompletionSource

public class UniRx.Async.UniTaskCompletionSource
    : IAwaiter, ICriticalNotifyCompletion, INotifyCompletion

Properties

Type Name Summary
UniTask Task

Methods

Type Name Summary
Boolean TrySetCanceled()
Boolean TrySetException(Exception exception)
Boolean TrySetResult()

UniTaskCompletionSource<T>

public class UniRx.Async.UniTaskCompletionSource<T>
    : IAwaiter<T>, IAwaiter, ICriticalNotifyCompletion, INotifyCompletion

Properties

Type Name Summary
UniTask<T> Task
UniTask UnitTask

Methods

Type Name Summary
Boolean TrySetCanceled()
Boolean TrySetException(Exception exception)
Boolean TrySetResult(T value)

UniTaskExtensions

public static class UniRx.Async.UniTaskExtensions

Static Methods

Type Name Summary
UniTask<AsyncUnit> AsAsyncUnitUniTask(this UniTask task) Convert UniTask -> UniTask[AsyncUnit].
UniTask<T> AsUniTask(this Task<T> task) Convert Task[T] -> UniTask[T].
UniTask AsUniTask(this Task task) Convert Task[T] -> UniTask[T].
UniTask ConfigureAwait(this Task task, PlayerLoopTiming timing)
UniTask<T> ConfigureAwait(this Task<T> task, PlayerLoopTiming timing)
UniTask ConfigureAwait(this UniTask task, PlayerLoopTiming timing)
UniTask<T> ConfigureAwait(this UniTask<T> task, PlayerLoopTiming timing)
UniTask ContinueWith(this UniTask<T> task, Action<T> continuationFunction)
UniTask ContinueWith(this UniTask<T> task, Func<T, UniTask> continuationFunction)
UniTask<TR> ContinueWith(this UniTask<T> task, Func<T, TR> continuationFunction)
UniTask<TR> ContinueWith(this UniTask<T> task, Func<T, UniTask<TR>> continuationFunction)
UniTask ContinueWith(this UniTask task, Action continuationFunction)
UniTask ContinueWith(this UniTask task, Func<UniTask> continuationFunction)
UniTask<T> ContinueWith(this UniTask task, Func<T> continuationFunction)
UniTask<T> ContinueWith(this UniTask task, Func<UniTask<T>> continuationFunction)
void Forget(this UniTask task, Action<Exception> exceptionHandler = null)
void Forget(this UniTask<T> task, Action<Exception> exceptionHandler = null)
UniTask Timeout(this UniTask task, TimeSpan timeout, CancellationTokenSource taskCancellationTokenSource = null)
UniTask<T> Timeout(this UniTask<T> task, TimeSpan timeout, CancellationTokenSource taskCancellationTokenSource = null)
IEnumerator ToCoroutine(this UniTask<T> task, Action<T> resultHandler = null, Action<Exception> exceptionHandler = null)
IEnumerator ToCoroutine(this UniTask task, Action<Exception> exceptionHandler = null)
UniTask WithCancellation(this UniTask task, CancellationToken cancellationToken, CancellationTokenSource taskCancellationTokenSource = null)
UniTask<T> WithCancellation(this UniTask<T> task, CancellationToken cancellationToken, CancellationTokenSource taskCancellationTokenSource = null)

UniTaskLoopRunners

public static class UniRx.Async.UniTaskLoopRunners

UniTaskVoid

public struct UniRx.Async.UniTaskVoid

Methods

Type Name Summary
void Forget()
Awaiter GetAwaiter()

UnityAsyncExtensions

public static class UniRx.Async.UnityAsyncExtensions

Static Methods

Type Name Summary
UniTask ConfigureAwait(this AsyncOperation asyncOperation, IProgress<Single> progress = null, PlayerLoopTiming timing = Update, CancellationToken cancellation = null)
UniTask<Object> ConfigureAwait(this ResourceRequest asyncOperation, IProgress<Single> progress = null, PlayerLoopTiming timing = Update, CancellationToken cancellation = null)
UniTask ConfigureAwait(this WWW www, IProgress<Single> progress = null, PlayerLoopTiming timing = Update, CancellationToken cancellation = null)
UniTask<UnityWebRequest> ConfigureAwait(this UnityWebRequestAsyncOperation asyncOperation, IProgress<Single> progress = null, PlayerLoopTiming timing = Update, CancellationToken cancellation = null)
UniTask ConfigureAwait(this JobHandle jobHandle, PlayerLoopTiming waitTiming, CancellationToken cancellation = null)
IAsyncClickEventHandler GetAsyncClickEventHandler(this Button button)
IAsyncEndEditEventHandler<String> GetAsyncEndEditEventHandler(this InputField inputField)
AsyncUnityEventHandler GetAsyncEventHandler(this UnityEvent unityEvent)
IAsyncValueChangedEventHandler<Boolean> GetAsyncValueChangedEventHandler(this Toggle toggle)
IAsyncValueChangedEventHandler<Single> GetAsyncValueChangedEventHandler(this Scrollbar scrollbar)
IAsyncValueChangedEventHandler<Vector2> GetAsyncValueChangedEventHandler(this ScrollRect scrollRect)
IAsyncValueChangedEventHandler<Single> GetAsyncValueChangedEventHandler(this Slider slider)
AsyncOperationAwaiter GetAwaiter(this AsyncOperation asyncOperation)
ResourceRequestAwaiter GetAwaiter(this ResourceRequest asyncOperation)
Awaiter GetAwaiter(this WWW www)
UnityWebRequestAsyncOperationAwaiter GetAwaiter(this UnityWebRequestAsyncOperation asyncOperation)
Awaiter GetAwaiter(this JobHandle jobHandle)
UniTask<String> OnEndEditAsync(this InputField inputField)
UniTask OnInvokeAsync(this UnityEvent unityEvent)
UniTask OnInvokeAsync(this Button button)
UniTask<Boolean> OnValueChangedAsync(this Toggle toggle)
UniTask<Single> OnValueChangedAsync(this Scrollbar scrollbar)
UniTask<Vector2> OnValueChangedAsync(this ScrollRect scrollRect)
UniTask<Single> OnValueChangedAsync(this Slider slider)
UniTask ToUniTask(this AsyncOperation asyncOperation)
UniTask<Object> ToUniTask(this ResourceRequest asyncOperation)
UniTask ToUniTask(this WWW www)
UniTask<UnityWebRequest> ToUniTask(this UnityWebRequestAsyncOperation asyncOperation)
UniTask ToUniTask(this JobHandle jobHandle, CancellationToken cancellation = null)

Reference document is generated by neuecc/MarkdownGenerator

Clone this wiki locally