Interface IAsyncPackageContentReader

Namespace

NuGet.Packaging

Assembly

Chocolatey.NuGet.Packaging.dll

An asynchronous package content reader.

public interface IAsyncPackageContentReader

Extension Methods

PackageReaderExtensions.GetSatelliteFilesAsync(IAsyncPackageContentReader, string, CancellationToken)

Methods

GetBuildItemsAsync(CancellationToken)

Asynchronously returns all items under the build folder.

Task<IEnumerable<FrameworkSpecificGroup>> GetBuildItemsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token.

Returns

Task<IEnumerable<FrameworkSpecificGroup>>

A task that represents the asynchronous operation. The task result (Result) returns an IEnumerable<T>.

GetContentItemsAsync(CancellationToken)

Asynchronously returns all items found in the content folder.

Task<IEnumerable<FrameworkSpecificGroup>> GetContentItemsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token.

Returns

Task<IEnumerable<FrameworkSpecificGroup>>

A task that represents the asynchronous operation. The task result (Result) returns an IEnumerable<T>.

Remarks

Some legacy behavior has been dropped here due to the mix of content folders and target framework folders here.

GetFrameworkItemsAsync(CancellationToken)

Asynchronously returns all framework references found in the nuspec.

Task<IEnumerable<FrameworkSpecificGroup>> GetFrameworkItemsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token.

Returns

Task<IEnumerable<FrameworkSpecificGroup>>

A task that represents the asynchronous operation. The task result (Result) returns an IEnumerable<T>.

GetLibItemsAsync(CancellationToken)

Asynchronously returns all lib items without any filtering.

Task<IEnumerable<FrameworkSpecificGroup>> GetLibItemsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token.

Returns

Task<IEnumerable<FrameworkSpecificGroup>>

A task that represents the asynchronous operation. The task result (Result) returns an IEnumerable<T>.

Remarks

Use GetReferenceItemsAsync(...) for the filtered list.

GetPackageDependenciesAsync(CancellationToken)

Asynchronously returns package dependencies.

Task<IEnumerable<PackageDependencyGroup>> GetPackageDependenciesAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token.

Returns

Task<IEnumerable<PackageDependencyGroup>>

A task that represents the asynchronous operation. The task result (Result) returns an IEnumerable<T>.

GetReferenceItemsAsync(CancellationToken)

Asynchronously returns lib items + filtering based on the nuspec and other NuGet rules.

Task<IEnumerable<FrameworkSpecificGroup>> GetReferenceItemsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token.

Returns

Task<IEnumerable<FrameworkSpecificGroup>>

A task that represents the asynchronous operation. The task result (Result) returns an IEnumerable<T>.

GetToolItemsAsync(CancellationToken)

Asynchronously returns all items under the tools folder.

Task<IEnumerable<FrameworkSpecificGroup>> GetToolItemsAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token.

Returns

Task<IEnumerable<FrameworkSpecificGroup>>

A task that represents the asynchronous operation. The task result (Result) returns an IEnumerable<T>.