Class AsyncInstallTaskEnumerable<T>

Represents an installation task that runs at most once, and yields multiple results of type T. It can also be passed to other installation tasks as a placeholder for the final result of T.

Inheritance

System.Object

AsyncInstallTaskEnumerable<T>

CopyDirectoryContentsTask

ExtractZipTask

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Snowflake.Installation

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public abstract class AsyncInstallTaskEnumerable<T>

Type Parameters

Name	Description
T	The type of the yielded results.

Properties

TaskName

A string identifier for the task.

Declaration

protected abstract string TaskName { get; }

Property Value

Type	Description
System.String

Methods

CreateFailureDescription(AggregateException)

Creates a description for the task on failure. A description should only depend on the inputs of the class.

Declaration

protected virtual ValueTask<string> CreateFailureDescription(AggregateException exception)

Parameters

Type	Name	Description
System.AggregateException	exception	The exception thrown by the task on failure.

Returns

Type	Description
System.Threading.Tasks.ValueTask<System.String>

CreateSuccessDescription(T)

Creates a description for the task on success. A description should only depend on the inputs of the task.

Declaration

protected virtual ValueTask<string> CreateSuccessDescription(T current)

Parameters

Type	Name	Description
T	current	The element currently being processed by the task.

Returns

Type	Description
System.Threading.Tasks.ValueTask<System.String>

ExecuteOnce()

Runs when the AsyncInstallTaskEnumerable<T> is evaluated.

Declaration

protected abstract IAsyncEnumerable<T> ExecuteOnce()

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<T>	The result of the AsyncInstallTaskEnumerable<T>.

GetAsyncEnumerator(CancellationToken)

Gets the System.Collections.Generic.IAsyncEnumerator<T> for the AsyncInstallTaskEnumerable<T>.

Declaration

public IAsyncEnumerator<TaskResult<T>> GetAsyncEnumerator(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerator<TaskResult<T>>	The System.Collections.Generic.IAsyncEnumerator<T> that results the AsyncInstallTaskEnumerable<T>.