Class ExtractZipTask

Extracts a ZIP file into a target directory.

Inheritance

System.Object

AsyncInstallTaskEnumerable<IFile>

ExtractZipTask

Inherited Members

AsyncInstallTaskEnumerable<IFile>.GetAsyncEnumerator(CancellationToken)

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.Tasks

Assembly: Snowflake.Framework.dll

Syntax

public sealed class ExtractZipTask : AsyncInstallTaskEnumerable<IFile>

Constructors

ExtractZipTask(TaskResult<FileInfo>, IDirectory)

Describes an extraction of a ZIP file into a target directory.

Declaration

public ExtractZipTask(TaskResult<FileInfo> fileInfo, IDirectory destination)

Parameters

Type	Name	Description
TaskResult<System.IO.FileInfo>	fileInfo	The ZIP file source.
IDirectory	destination	The destination directory.

Properties

Destination

Declaration

public IDirectory Destination { get; }

Property Value

Type	Description
IDirectory

FileInfo

Declaration

public TaskResult<FileInfo> FileInfo { get; }

Property Value

Type	Description
TaskResult<System.IO.FileInfo>

TaskName

Declaration

protected override string TaskName { get; }

Property Value

Type	Description
System.String

Overrides

Snowflake.Installation.AsyncInstallTaskEnumerable<Snowflake.Filesystem.IFile>.TaskName

Methods

CreateFailureDescription(AggregateException)

Declaration

protected override ValueTask<string> CreateFailureDescription(AggregateException e)

Parameters

Type	Name	Description
System.AggregateException	e

Returns

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

Overrides

Snowflake.Installation.AsyncInstallTaskEnumerable<Snowflake.Filesystem.IFile>.CreateFailureDescription(System.AggregateException)

CreateSuccessDescription(IFile)

Declaration

protected override ValueTask<string> CreateSuccessDescription(IFile current)

Parameters

Type	Name	Description
IFile	current

Returns

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

Overrides

Snowflake.Installation.AsyncInstallTaskEnumerable<Snowflake.Filesystem.IFile>.CreateSuccessDescription(Snowflake.Filesystem.IFile)

ExecuteOnce()

Declaration

protected override IAsyncEnumerable<IFile> ExecuteOnce()

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<IFile>

Overrides

Snowflake.Installation.AsyncInstallTaskEnumerable<Snowflake.Filesystem.IFile>.ExecuteOnce()