CompressDeflateAsync Method

Definition

Namespace

Cuemon.Extensions.IO

Assemblies

Cuemon.Extensions.IO.dll

Source

src/Cuemon.Extensions.IO/StreamExtensions.cs

CompressDeflateAsync(Stream, Action<AsyncStreamCompressionOptions>)

Compresses the value using the DEFLATE algorithm.

public static Task<Stream> CompressDeflateAsync(this Stream value, Action<AsyncStreamCompressionOptions> setup = null)

Parameters

value Stream

The Stream to extend.

setup Action<AsyncStreamCompressionOptions>

The AsyncStreamCompressionOptions which may be configured.

Returns

Task<Stream>

A DEFLATE compressed Stream of the value.

Exceptions

ArgumentNullException

value cannot be null.

ArgumentException

value does not support write operations such as compression.