VersaTul.Compression 1.0.16

VersaTul Compression

The VersaTul Compression project provides functionality to compress and decompress streams. It is built around the .NET System.IO.Compression classes, making it easy to work with compressed data. Let's dive into the details:

Features

1. Stream Compression: The project enables you to compress and decompress streams efficiently. It uses the built-in ZipStream class to quickly compress MemoryStreams into archive streams.

Usage

To use the VersaTul Compression project, follow these steps:

1. Install the Package: You can install the VersaTul.Compression package from NuGet using the following command:

   PM> NuGet\Install-Package VersaTul.Compression --version 1.0.14
   

2. Create a Compressed Stream:

   • Use the ZipStream class to compress a MemoryStream containing your data.
   • The compressed stream can be stored or transmitted efficiently.

3. Decompress the Stream:

   • When needed, decompress the stream using the same ZipStream class.
   • Retrieve the original data from the decompressed stream.

Example

Here's a simple example of compressing and decompressing a stream:

using System.IO;
using VersaTul.Compression;

class Program
{
    static void Main()
    {
        // Create some sample data
        byte[] originalData = Encoding.UTF8.GetBytes("Hello, this is some data to compress!");

        // Compress the data
        using (var compressedStream = new MemoryStream())
        {
            using (var zipStream = new ZipStream(compressedStream, CompressionMode.Compress))
            {
                zipStream.Write(originalData, 0, originalData.Length);
            }

            // Store or transmit the compressed stream
            // ...

            // Decompress the stream
            using (var decompressedStream = new MemoryStream())
            {
                using (var unzipStream = new ZipStream(compressedStream, CompressionMode.Decompress))
                {
                    unzipStream.CopyTo(decompressedStream);
                }

                // Retrieve the original data
                byte[] decompressedData = decompressedStream.ToArray();
                string originalText = Encoding.UTF8.GetString(decompressedData);
                Console.WriteLine($"Decompressed data: {originalText}");
            }
        }
    }
}

License

This project is licensed under the MIT License. See the LICENSE file for details.