Class PackageExtractor

Namespace

NuGet.Packaging

Assembly

Chocolatey.NuGet.Packaging.dll

public static class PackageExtractor

Inheritance

object

PackageExtractor

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

CopySatelliteFilesAsync(PackageIdentity, PackagePathResolver, PackageSaveMode, PackageExtractionContext, CancellationToken)

public static Task<IEnumerable<string>> CopySatelliteFilesAsync(PackageIdentity packageIdentity, PackagePathResolver packagePathResolver, PackageSaveMode packageSaveMode, PackageExtractionContext packageExtractionContext, CancellationToken token)

Parameters

packageIdentity PackageIdentity

packagePathResolver PackagePathResolver

packageSaveMode PackageSaveMode

packageExtractionContext PackageExtractionContext

token CancellationToken

Returns

Task<IEnumerable<string>>

ExtractPackageAsync(string, PackageReaderBase, PackagePathResolver, PackageExtractionContext, CancellationToken, Guid)

public static Task<IEnumerable<string>> ExtractPackageAsync(string source, PackageReaderBase packageReader, PackagePathResolver packagePathResolver, PackageExtractionContext packageExtractionContext, CancellationToken token, Guid parentId = default)

Parameters

source string

packageReader PackageReaderBase

packagePathResolver PackagePathResolver

packageExtractionContext PackageExtractionContext

token CancellationToken

parentId Guid

Returns

Task<IEnumerable<string>>

ExtractPackageAsync(string, PackageReaderBase, Stream, PackagePathResolver, PackageExtractionContext, CancellationToken, Guid)

public static Task<IEnumerable<string>> ExtractPackageAsync(string source, PackageReaderBase packageReader, Stream packageStream, PackagePathResolver packagePathResolver, PackageExtractionContext packageExtractionContext, CancellationToken token, Guid parentId = default)

Parameters

source string

packageReader PackageReaderBase

packageStream Stream

packagePathResolver PackagePathResolver

packageExtractionContext PackageExtractionContext

token CancellationToken

parentId Guid

Returns

Task<IEnumerable<string>>

ExtractPackageAsync(string, Stream, PackagePathResolver, PackageExtractionContext, CancellationToken, Guid)

public static Task<IEnumerable<string>> ExtractPackageAsync(string source, Stream packageStream, PackagePathResolver packagePathResolver, PackageExtractionContext packageExtractionContext, CancellationToken token, Guid parentId = default)

Parameters

source string

packageStream Stream

packagePathResolver PackagePathResolver

packageExtractionContext PackageExtractionContext

token CancellationToken

parentId Guid

Returns

Task<IEnumerable<string>>

InstallFromSourceAsync(PackageIdentity, IPackageDownloader, VersionFolderPathResolver, PackageExtractionContext, CancellationToken, Guid)

public static Task<bool> InstallFromSourceAsync(PackageIdentity packageIdentity, IPackageDownloader packageDownloader, VersionFolderPathResolver versionFolderPathResolver, PackageExtractionContext packageExtractionContext, CancellationToken token, Guid parentId = default)

Parameters

packageIdentity PackageIdentity

packageDownloader IPackageDownloader

versionFolderPathResolver VersionFolderPathResolver

packageExtractionContext PackageExtractionContext

token CancellationToken

parentId Guid

Returns

Task<bool>

InstallFromSourceAsync(string, PackageIdentity, Func<Stream, Task>, VersionFolderPathResolver, PackageExtractionContext, CancellationToken, Guid)

Uses a copy function to install a package to a global packages directory.

public static Task<bool> InstallFromSourceAsync(string source, PackageIdentity packageIdentity, Func<Stream, Task> copyToAsync, VersionFolderPathResolver versionFolderPathResolver, PackageExtractionContext packageExtractionContext, CancellationToken token, Guid parentId = default)

Parameters

source string

packageIdentity PackageIdentity

copyToAsync Func<Stream, Task>

A function which should copy the package to the provided destination stream.

versionFolderPathResolver VersionFolderPathResolver

packageExtractionContext PackageExtractionContext

The version folder path context, which encapsulates all of the parameters to observe while installing the package.

token CancellationToken

The cancellation token.

parentId Guid

Returns

Task<bool>

True if the package was installed. False if the package already exists and therefore resulted in no copy operation.