Compression.cs

using System.IO.Compression;

namespace BytecodeApi.IO;

/// <summary>
/// Class to compress and decompress data using GZip.
/// </summary>
public static class Compression
{
	/// <summary>
	/// Compresses the specified <see cref="byte" />[] using GZip and returns a new <see cref="byte" />[] that can be used with the <see cref="Decompress" /> method.
	/// </summary>
	/// <param name="data">A <see cref="byte" />[] that represents data to be compressed.</param>
	/// <returns>
	/// A new <see cref="byte" />[] that can be used with the <see cref="Decompress" /> method.
	/// </returns>
	public static byte[] Compress(byte[] data)
	{
		return Compress(data, CompressionLevel.Optimal);
	}
	/// <summary>
	/// Compresses the specified <see cref="byte" />[] using GZip and returns a new <see cref="byte" />[] that can be used with the <see cref="Decompress" /> method.
	/// </summary>
	/// <param name="data">A <see cref="byte" />[] that represents data to be compressed.</param>
	/// <param name="compressionLevel">The level of compression to use to either emphasize speed or compression efficiency.</param>
	/// <returns>
	/// A new <see cref="byte" />[] that can be used with the <see cref="Decompress" /> method.
	/// </returns>
	public static byte[] Compress(byte[] data, CompressionLevel compressionLevel)
	{
		Check.ArgumentNull(data);

		using MemoryStream memoryStream = new();
		using (GZipStream gzipStream = new(memoryStream, compressionLevel, true))
		{
			gzipStream.Write(data);
		}

		return memoryStream.ToArray();
	}
	/// <summary>
	/// Decompresses the specified <see cref="byte" />[] using GZip and returns a new <see cref="byte" />[] that represents the uncompressed data.
	/// </summary>
	/// <param name="data">A <see cref="byte" />[] that represents data compressed by the <see cref="Compress(byte[])" /> method.</param>
	/// <returns>
	/// A new <see cref="byte" />[] that represents the uncompressed data.
	/// </returns>
	public static byte[] Decompress(byte[] data)
	{
		Check.ArgumentNull(data);

		using MemoryStream memoryStream = new();
		using (GZipStream gzipStream = new(new MemoryStream(data), CompressionMode.Decompress))
		{
			gzipStream.CopyTo(memoryStream);
		}

		return memoryStream.ToArray();
	}
}