Class AsyncLazy<T>

Namespace

Garyon.Objects.Advanced

Assembly

Garyon.dll

Provides a mechanism for a lazily initializable value that is created asynchronously.

public sealed class AsyncLazy<T>

Type Parameters

T

The type of the lazily initializable value.

Inheritance

object

AsyncLazy<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparisonExtensions.BeginCompare<T>(T, T)

IEnumeratorExtensions.GetEnumerator<TEnumerator, TValue>(TEnumerator)

MoreLinqExtensions.Apply<TSource>(TSource, Action<TSource>)

MoreLinqExtensions.Apply<TSource, TResult>(TSource, Func<TSource, TResult>)

SingleValueEnumeratorExtensions.EnumerateSingle<T>(T)

Remarks

This type caches the Task<TResult> returned by the factory. The factory is invoked at most once unless ClearValue() is called.

Constructors

AsyncLazy(Func<Task<T>>)

Initializes a new instance of the AsyncLazy<T> class from an async factory method.

public AsyncLazy(Func<Task<T>> factory)

Parameters

factory Func<Task<T>>

The factory method that will be used to lazily initialize the value.

AsyncLazy(T)

Initializes a new instance of the AsyncLazy<T> class from a given value.

public AsyncLazy(T value)

Parameters

value T

The value to initialize this instance with.

Properties

IsValueCreated

Determines whether the value has been created (i.e. the factory was invoked) or not.

public bool IsValueCreated { get; }

Property Value

bool

ValueTaskOrDefault

Gets the cached Task<TResult> if the value has already been requested, or null otherwise.

public Task<T>? ValueTaskOrDefault { get; }

Property Value

Task<T>

Methods

ClearValue()

Clears the cached value. Upon the next call of GetValueAsync(), the value will be lazily initialized again.

public void ClearValue()

GetValueAsync()

Gets the lazily initializable value asynchronously. If the value has not been created yet, this method activates its initialization.

public Task<T> GetValueAsync()

Returns

Task<T>