Ogu.Compressions 1.0.0

Ogu.Compressions

This library provides concrete implementations of most popular compression algorithms using third-party libraries and also some utilities

Usage

Registering all compressions including CompressionFactory ( Brotli, Deflate, Snappy, Zstd, Gzip, None ):

services.AddCompressions(opts =>
{
    opts.Level = CompressionLevel.Optimal;
});

To resolve a specific compression:

private readonly IBrotliCompression _compression;

public BrotliController(IBrotliCompression compression)
{
     compression = compression;
}

To resolve other compression types;

• Deflate: IDeflateCompression
• Snappy: ISnappyCompression
• Zstd: IZstdCompression
• Gzip: IGzipCompression
• None: INoneCompression

To resolve compression using ICompressionFactory:

private readonly ICompressionFactory _compressionFactory;

public DecompressionHandler(ICompressionFactory compressionFactory)
{
    _compressionFactory = compressionFactory;
}

brotli compression

var brotliCompression = _compressionFactory.Get(CompressionType.Brotli);

Adding decompression handler to HttpClient

// registration
services.AddTransient<DecompressionHandler>();
services.AddHttpClient("DecompressionHandler").AddHttpMessageHandler<DecompressionHandler>();

// Register ICompressionFactory for DecompressionHandler to support all compressions including ICompressionFactory
services.AddCompressions(opts =>
{
    opts.Level = CompressionLevel.Optimal;
});

To use

private readonly HttpClient _httpClient;

public DecompressionHandlerController(IHttpClientFactory httpClientFactory)
{
    _httpClient = httpClientFactory.CreateClient("DecompressionHandler");

    // Request encoding (br, gzip) from server if possible
    CompressionType.Brotli.AddToRequestHeaders(_httpClient.DefaultRequestHeaders);
    CompressionType.Gzip.AddToRequestHeaders(_httpClient.DefaultRequestHeaders);
}

// When making requests through _httpClient, the DecompressionHandler will decompress if the content is encoded

Links:

• GitHub
• Documentation