Struct Promise

Namespace

MarymoorStudios.Core.Promises

Assembly

MarymoorStudios.Core.Promises.dll

A representation of the future outcome of a computation.

public readonly struct Promise

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

PromiseFinally.Finally(Promise, Action, Action<Exception>)

PromiseFinally.Finally(Promise, Func<Promise>, Func<Exception, Promise>)

PromiseFinally.Finally<TResult>(Promise, Func<Promise<TResult>>, Func<Exception, Promise<TResult>>)

PromiseJoin.Join(Promise, Promise)

PromiseJoin.Join(Promise, params Promise[])

PromiseOnCompleted.OnCompleted(Promise, Action, Action<Exception>)

PromiseWhen.When(Promise, Action)

PromiseWhen.When(Promise, Func<Promise>)

PromiseWhen.When<TResult>(Promise, Func<Promise<TResult>>)

PromiseWithCancellation.WithCancellation(Promise, CancellationToken)

Remarks

A promise can be used to reify, track, compose, and wait for the completion of a computation.

The outcome (success or failure) cannot be known until after the computation has completed. This is called "resolving" the outcome.

Constructors

Promise()

Creates a successfully resolved promise.

public Promise()

Promise(Promise)

Creates a forwarded promise whose outcome will be the same as p.

public Promise(Promise p)

Parameters

p Promise

Promise(Resolver<Void>)

Creates an unresolved promise whose future outcome is defined by r.

public Promise(Resolver<Void> r)

Parameters

r Resolver<Void>

Promise(Exception)

Creates a failed promise whose outcome is ex.

public Promise(Exception ex)

Parameters

ex Exception

Properties

Done

An already successfully resolved promise.

public static Promise Done { get; }

Property Value

Promise

Failure

The error the promise failed with.

public Exception Failure { get; }

Property Value

Exception

Remarks

REQUIRES: the promise has failed.

IsFailed

True if the promise has failed.

public bool IsFailed { get; }

Property Value

bool

IsResolved

True if the promise is in a resolved state (either success or failure).

public bool IsResolved { get; }

Property Value

bool

IsSuccess

True if the promise has been resolved successfully.

public bool IsSuccess { get; }

Property Value

bool

Methods

AppendOne(Turn)

Dispatches a turn.

public void AppendOne(Turn turn)

Parameters

turn Turn

A turn to schedule when resolved.

From<T>(Resolver<T>)

Creates an unresolved promise whose future outcome is defined by r.

public static Promise<T> From<T>(Resolver<T> r)

Parameters

r Resolver<T>

The resolver

Returns

Promise<T>

Type Parameters

T

The type of the value.

From<T>(Exception)

Creates a failed promise whose outcome is ex.

public static Promise<T> From<T>(Exception ex)

Parameters

ex Exception

The failure.

Returns

Promise<T>

Type Parameters

T

The type of the value.

From<T>(T)

An already successfully resolved promise.

public static Promise<T> From<T>(T value)

Parameters

value T

The value

Returns

Promise<T>

Type Parameters

T

The type of the value.

GetAwaiter()

Enables await keyword.

public PromiseAwaiter GetAwaiter()

Returns

PromiseAwaiter

Operators

implicit operator Promise<Void>(Promise)

Converts a Promise to an equivalent Promise<T>.

public static implicit operator Promise<Void>(Promise p)

Parameters

p Promise

The promise to convert.

Returns

Promise<Void>

implicit operator Promise(Promise<Void>)

Converts a Promise<T> to an equivalent Promise.

public static implicit operator Promise(Promise<Void> p)

Parameters

p Promise<Void>

The promise to convert.

Returns

Promise