Class AsyncStreamCompressionOptions

Namespace: Cuemon.IO

Assembly: Cuemon.IO.dll

Configuration options for compressed Stream.

public class AsyncStreamCompressionOptions : AsyncStreamCopyOptions, IAsyncOptions, IParameterObject

Inheritance: object

AsyncOptions

AsyncDisposableOptions

AsyncStreamCopyOptions

AsyncStreamCompressionOptions

Implements: IAsyncOptions

IParameterObject

Inherited Members: AsyncStreamCopyOptions.BufferSize

AsyncDisposableOptions.LeaveOpen

AsyncOptions.CancellationToken

AsyncOptions.CancellationTokenProvider

Examples

AsyncStreamCompressionOptions configures compression level and buffer size for asynchronous stream compression operations. This example creates default options with CompressionLevel.Optimal and an 81920 buffer size, fast options with CompressionLevel.Fastest and a 4096 buffer for CPU-sensitive scenarios, and no-compression options for testing or passthrough use. Key steps include compressing sample data using DeflateStream with the configured options and comparing original vs. compressed byte sizes. Console output shows the default level (Optimal), buffer size, and the compression ratio between original and compressed sizes.

using System;
using System.IO;
using System.IO.Compression;
using System.Text;
using System.Threading.Tasks;
using Cuemon.IO;

namespace MyApp.IO
{
    public class AsyncStreamCompressionOptionsExample
    {
        public async Task DemonstrateAsync()
        {
            // Default compression: Optimal balance of speed and size
            var defaultOptions = new AsyncStreamCompressionOptions();
            Console.WriteLine($"Default level: {defaultOptions.Level}"); // Optimal
            Console.WriteLine($"Default buffer size: {defaultOptions.BufferSize}"); // 81920

            // Fastest compression for CPU-sensitive scenarios
            var fastOptions = new AsyncStreamCompressionOptions
            {
                Level = CompressionLevel.Fastest,
                BufferSize = 4096
            };

            // Compress data using the configured options
            byte[] original = Encoding.UTF8.GetBytes("This is sample data that will be compressed using AsyncStreamCompressionOptions.");
            using var source = new MemoryStream(original);
            using var compressed = new MemoryStream();

            using (var deflateStream = new DeflateStream(compressed, fastOptions.Level, leaveOpen: true))
            {
                await source.CopyToAsync(deflateStream, fastOptions.BufferSize);

            Console.WriteLine($"Original size: {original.Length} bytes");
            Console.WriteLine($"Compressed size: {compressed.Length} bytes");

            // No compression level for testing or passthrough scenarios
            var noCompressionOptions = new AsyncStreamCompressionOptions
            {
                Level = CompressionLevel.NoCompression
            };
            Console.WriteLine($"No compression level: {noCompressionOptions.Level}");

}}}
}

Constructors

AsyncStreamCompressionOptions()

Initializes a new instance of the AsyncStreamCompressionOptions class.

public AsyncStreamCompressionOptions()

Remarks

The following table shows the initial property values for an instance of AsyncStreamCompressionOptions.

Property	Initial Value
Level	Optimal

Properties

Level

Gets or sets the enumeration values that indicates whether to emphasize speed or compression efficiency when compressing the stream.

public CompressionLevel Level { get; set; }

Property Value

CompressionLevel: The level of the compression.

Table of Contents