DecompressGZipAsync Method

Definition

Namespace

Cuemon.IO

Assemblies

Cuemon.IO.dll

Source

src/Cuemon.IO/Extensions/StreamDecoratorExtensions.cs

DecompressGZipAsync(IDecorator<Stream>, Action<AsyncStreamCopyOptions>)

Decompress the enclosed Stream of the specified decorator using GZip data format specification.

public static Task<Stream> DecompressGZipAsync(this IDecorator<Stream> decorator, Action<AsyncStreamCopyOptions> setup = null)

Parameters

decorator IDecorator<Stream>

The IDecorator<T> to extend.

setup Action<AsyncStreamCopyOptions>

The AsyncStreamCopyOptions which may be configured.

Returns

Task<Stream>

A task that represents the asynchronous operation. The task result contains a decompressed version of the enclosed Stream of the specified decorator.

Exceptions

ArgumentNullException

decorator cannot be null.

ArgumentException

The enclosed Stream of decorator does not support write operations such as compression.

InvalidDataException

The enclosed Stream of decorator was compressed using an unsupported compression method.